Skip to content

Commit

Permalink
Docs: add quick start outline to README.md (#46)
Browse files Browse the repository at this point in the history
Docs are not complete, but conceivably enough pieces are here to see what we're doing here and try it out.
  • Loading branch information
catflydotio authored Sep 14, 2023
1 parent 5af95e5 commit d00b4f7
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,12 @@ Run the Corrosion agent on every node/host in the cluster. Other programs runnin

The [Corrosion CLI](/doc/cli/README.md) provides commands for administration and access to database and features.

### Quick start

- [Prepare the Corrosion configuration file](config/README.md)
- [Specify the initial database schema](schema.md)
- [Start the Corrosion agent](cli/agent.md)

See the WIP [Corrosion documentation](/doc/SUMMARY.md) for more details.

## Building Corrosion
Expand Down
12 changes: 11 additions & 1 deletion doc/config/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,11 @@
# Configuration
# Configuration

Corrosion configuration lives in a TOML file. The default location is `/etc/corrosion/config.toml`.

Configuration sections:
- [db](db.md)
- [gossip](gossip.md)
- [api]() (to come)
- [admin]() (to come)
- [telemetry]() (to come)
- [consul]() (to come)

0 comments on commit d00b4f7

Please sign in to comment.