erika/constellation
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update readme

Browse source
This commit is contained in:
Erika Rowland 2024-03-30 23:47:36 -07:00
parent d08040a8e5
commit 9557ae5538
1 changed files with 1 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -1,25 +1,3 @@
# constellation # constellation
[![Package Version](https://img.shields.io/hexpm/v/constellation)](https://hex.pm/packages/constellation) A simple webring database generator.
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/constellation/)
```sh
gleam add constellation
```
```gleam
import constellation
pub fn main() {
// TODO: An example of the project in use
}
```
Further documentation can be found at <https://hexdocs.pm/constellation>.
## Development
```sh
gleam run # Run the project
gleam test # Run the tests
gleam shell # Run an Erlang shell
```