README: update

This commit is contained in:
0x1eef 2024-03-11 14:45:11 -03:00
parent e871c5309a
commit 2350a8d56e
4 changed files with 13 additions and 21 deletions

View file

@ -1,7 +1,8 @@
## About
Twenty helps you manage your projects with a web application
that runs on your computer.
Twenty helps you manage and plan your open source projects with a
standalone web application that's designed to run on localhost or
within your local network. It is both easy to use, and easy to install.
## Features
@ -14,25 +15,24 @@ that runs on your computer.
## Design
* The server is powered by [ruby/webrick](https://github.com/ruby/webrick):
* Accepts GraphQL requests at `/graphql`.
* Serves client (HTML, JS, CSS).
* Dependencies: ActiveRecord, SQLite3, ruby-graphql.
- Accepts GraphQL requests at `/graphql`.
- Serves client (HTML, JS, CSS).
- Dependencies: ActiveRecord, 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.
## Usage
The CLI is available as two identical executables: <br>
`$ 20`, and `$ twenty`.
**CLI**
Usage: 20 COMMAND [OPTIONS]
Usage: twenty COMMAND [OPTIONS]
Commands:
up Start the twenty web server.
@ -42,10 +42,6 @@ The CLI is available as two identical executables: <br>
migrate Migrate the database.
console Start the twenty developer console.
## Screenshots
![img](./share/twenty/demo.png)
## Install
$ gem install twenty.rb

Binary file not shown.

Before

Width:  |  Height:  |  Size: 62 KiB

View file

@ -1,4 +0,0 @@
#!/usr/bin/env ruby
# frozen_string_literal: true
Process.wait spawn([File.join(__dir__, "twenty"), "20"], *ARGV)

View file

@ -24,7 +24,7 @@ when "console"
wait spawn("console", *ARGV[1..])
exit $?.exitstatus
else
warn "Usage: 20 COMMAND [OPTIONS]\n\n" \
warn "Usage: twenty COMMAND [OPTIONS]\n\n" \
"Commands:\n" \
" up Start the twenty web server.\n" \
" down Stop the twenty web server.\n" \