Update readme
This commit is contained in:
parent
d08040a8e5
commit
9557ae5538
1 changed files with 1 additions and 23 deletions
24
README.md
24
README.md
|
@ -1,25 +1,3 @@
|
|||
# constellation
|
||||
|
||||
[![Package Version](https://img.shields.io/hexpm/v/constellation)](https://hex.pm/packages/constellation)
|
||||
[![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
|
||||
```
|
||||
A simple webring database generator.
|
||||
|
|
Loading…
Reference in a new issue