Fix README
This commit is contained in:
parent
e0c44c96e9
commit
07787710e5
1 changed files with 21 additions and 21 deletions
42
README.md
42
README.md
|
@ -6,27 +6,27 @@ local network.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
* Provides a command-line utility to start / stop a web server.
|
* Provides a command-line utility to start / stop a web server
|
||||||
* Connect / disconnect a project from the command line.
|
* Connect / disconnect a project from the command line
|
||||||
* Designed to work offline.
|
* Designed to work offline
|
||||||
* Lightweight stack.
|
* Lightweight stack
|
||||||
* Easy to install, easy to use.
|
* Easy to install, easy to use
|
||||||
|
|
||||||
## Design
|
## Design
|
||||||
|
|
||||||
* The server is powered by [rack](https://github.com/rack/rack) and [puma](https://github.com/puma/puma):
|
* The server is powered by [rack](https://github.com/rack/rack) and [puma](https://github.com/puma/puma):
|
||||||
- Accepts GraphQL requests at `/graphql`.
|
- Accepts GraphQL requests at `/graphql`
|
||||||
- Serves client (HTML, JS, CSS).
|
- Serves client (HTML, JS, CSS)
|
||||||
- Dependencies: Sequel, SQLite3, ruby-graphql.
|
- Dependencies: Sequel, SQLite3, ruby-graphql
|
||||||
* The client is a statically compiled [nanoc](https://github.com/nanoc/nanoc) website:
|
* 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:
|
* The CLI controls the web server:
|
||||||
- Start / stop web server.
|
- Start / stop web server
|
||||||
- Run database migrations.
|
- Run database migrations
|
||||||
- Run developer console.
|
- Run developer console
|
||||||
* Each component (server, client, cli) are separate packages
|
* Each component (server, client, cli) are separate packages
|
||||||
in a monorepo.
|
in a monorepo
|
||||||
* Easy to distribute as a RubyGem.
|
* Easy to distribute as a RubyGem
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
@ -35,16 +35,16 @@ local network.
|
||||||
Usage: twenty COMMAND [OPTIONS]
|
Usage: twenty COMMAND [OPTIONS]
|
||||||
|
|
||||||
Commands:
|
Commands:
|
||||||
up Start the twenty web server.
|
up Start the twenty web server
|
||||||
down Stop the twenty web server.
|
down Stop the twenty web server
|
||||||
connect Connect a project to twenty.
|
connect Connect a project to twenty
|
||||||
disconnect Disconnect a project from twenty.
|
disconnect Disconnect a project from twenty
|
||||||
migrate Migrate the database.
|
migrate Migrate the database
|
||||||
console Start the twenty developer console.
|
console Start the twenty developer console
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
Twenty is distributed as a RubyGem.
|
Twenty is distributed as a RubyGem:
|
||||||
|
|
||||||
$ gem install twenty
|
$ gem install twenty
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue