serokell / coffer

Multi-backend password store with multiple frontends

4 stars 2 forks source link

Add Readme and project description #74

Closed dcastro closed 2 years ago

dcastro commented 2 years ago

Clarification and motivation

We should fill in the project's README. This should include:

A short description of what coffer does + will do in the future.
Which problems with the existing state of the art we're trying to address.
How to install, configure, and use the tool
How to setup a local dev environment
- This includes how to setup a local vault instance
- How to run unit & golden tests

We should also:

write a short description in the description field of package.yaml.
add a description to the CLI's --help command (see TODOs in CLI.Parser.parserInfo)

Acceptance criteria

The following have been updated: README.md, package.yaml and CLI.Parser.parserInfo.