diff --git a/README.md b/README.md index 4023ca3..9257237 100644 --- a/README.md +++ b/README.md @@ -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:
-`$ 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:
migrate Migrate the database. console Start the twenty developer console. -## Screenshots - -![img](./share/twenty/demo.png) - ## Install $ gem install twenty.rb diff --git a/share/twenty/demo.png b/share/twenty/demo.png deleted file mode 100644 index 4967ad3..0000000 Binary files a/share/twenty/demo.png and /dev/null differ diff --git a/twenty-cli/bin/20 b/twenty-cli/bin/20 deleted file mode 100755 index f2a1e0f..0000000 --- a/twenty-cli/bin/20 +++ /dev/null @@ -1,4 +0,0 @@ -#!/usr/bin/env ruby -# frozen_string_literal: true - -Process.wait spawn([File.join(__dir__, "twenty"), "20"], *ARGV) diff --git a/twenty-cli/bin/twenty b/twenty-cli/bin/twenty index aa87f90..fa51380 100755 --- a/twenty-cli/bin/twenty +++ b/twenty-cli/bin/twenty @@ -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" \