Skip to content

Commit

Permalink
doc: minor updates to root README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
eseidel committed Feb 17, 2024
1 parent efe045d commit 2640b3b
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@

A Dart client for spacetraders.io.

## Contents
* packages/cli - The main CLI for "playing" the game.
* packages/db - Postgres bindings for storing client state.
* packages/openapi - A generated Dart client for the Space Traders API.
* packages/server - A very basic server for supporting the UI.
* packages/types - Shared types between the packages.
* packages/ui - A Flutter UI for the Space Traders API.

packages/cli, packages/db and packages/types are all well developed.
packages/openapi is generated (and pretty terrible code).
packages/server and packages/ui are mostly stubs.
## Packages
* [cli](cli) - The main CLI for "playing" the game.
* [db](db) - Postgres bindings for storing client state.
* [openapi](openapi) - A generated Dart client for the Space Traders API.
* [server](server) - A very basic server for supporting the UI.
* [types](types) - Shared types between the packages.
* [ui](ui) - A Flutter UI for the Space Traders API.

`cli`, `db` and `types` are the most complete and useful packages.
`openapi` is generated (and pretty terrible code).
`server` and `ui` are mostly stubs.

## Setup

Expand Down

0 comments on commit 2640b3b

Please sign in to comment.