updated readme

This commit is contained in:
Dominic Grimm 2021-10-23 12:23:24 +02:00
parent 2bd7f722d0
commit 88e6e0de7a

View file

@ -1,5 +1,7 @@
# Compiled License
A fork of [elorest](https://github.com/elorest)'s library.
Compiles the licences of all shards used in project into binary.
This allows you to legally distribute binaries without having to package the licenses files from the shards.
@ -10,7 +12,7 @@ Add this to your application's `shard.yml`:
```yaml
dependencies:
compiled_license:
github: elorest/compiled_license
github: grimmigerFuchs/compiled_license
```
## Usage
@ -25,13 +27,13 @@ Compile and run
```
$ crystal build src/testapp.cr
$ testapp --licenses
$ testapp
# Returns all licenses to stdout
```
## Contributing
1. Fork it ( https://github.com/elorest/compiled_license/fork )
1. Fork it ( https://github.com/grimmigerFuchs/compiled_license/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)
@ -40,3 +42,4 @@ $ testapp --licenses
## Contributors
- [elorest](https://github.com/elorest) Isaac Sloan - creator, maintainer
- [grimmigerFuchs](https://github.com/grimmigerFuchs) - contributor