Fix README

This commit is contained in:
0x1eef 2024-04-26 14:08:38 -03:00
parent e0c44c96e9
commit 07787710e5

View file

@ -6,27 +6,27 @@ local network.
## Features
* Provides a command-line utility to start / stop a web server.
* Connect / disconnect a project from the command line.
* Designed to work offline.
* Lightweight stack.
* Easy to install, easy to use.
* Provides a command-line utility to start / stop a web server
* Connect / disconnect a project from the command line
* Designed to work offline
* Lightweight stack
* Easy to install, easy to use
## Design
* The server is powered by [rack](https://github.com/rack/rack) and [puma](https://github.com/puma/puma):
- Accepts GraphQL requests at `/graphql`.
- Serves client (HTML, JS, CSS).
- Dependencies: Sequel, SQLite3, ruby-graphql.
- Accepts GraphQL requests at `/graphql`
- Serves client (HTML, JS, CSS)
- Dependencies: Sequel, SQLite3, ruby-graphql
* The client is a statically compiled [nanoc](https://github.com/nanoc/nanoc) website:
- Dependencies: webpack, typescript, react.
- Dependencies: webpack, typescript, react
* The CLI controls the web server:
- Start / stop web server.
- Run database migrations.
- Run developer console.
- Start / stop web server
- Run database migrations
- Run developer console
* Each component (server, client, cli) are separate packages
in a monorepo.
* Easy to distribute as a RubyGem.
in a monorepo
* Easy to distribute as a RubyGem
## Usage
@ -35,16 +35,16 @@ local network.
Usage: twenty COMMAND [OPTIONS]
Commands:
up Start the twenty web server.
down Stop the twenty web server.
connect Connect a project to twenty.
disconnect Disconnect a project from twenty.
migrate Migrate the database.
console Start the twenty developer console.
up Start the twenty web server
down Stop the twenty web server
connect Connect a project to twenty
disconnect Disconnect a project from twenty
migrate Migrate the database
console Start the twenty developer console
## Install
Twenty is distributed as a RubyGem.
Twenty is distributed as a RubyGem:
$ gem install twenty