cre2/README.md

40 lines
736 B
Markdown
Raw Normal View History

2024-08-08 15:35:18 +00:00
# cre2
TODO: Write a description here
## Installation
1. Add the dependency to your `shard.yml`:
```yaml
dependencies:
cre2:
github: your-github-user/cre2
```
2. Run `shards install`
## Usage
```crystal
require "cre2"
```
TODO: Write usage instructions here
## Development
TODO: Write development instructions here
## Contributing
1. Fork it (<https://github.com/your-github-user/cre2/fork>)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Contributors
- [Roberto Alsina](https://github.com/your-github-user) - creator and maintainer