compiled_license/README.md

43 lines
916 B
Markdown
Raw Normal View History

2018-04-03 03:59:18 +00:00
# Compiled License
2018-04-03 03:58:44 +00:00
Compiles the licences of all shards used in project into binary.
2018-04-03 04:03:14 +00:00
This allows you to legally distribute binaries without having to package the licenses files from the shards.
2018-02-20 03:46:14 +00:00
## Installation
Add this to your application's `shard.yml`:
```yaml
dependencies:
compiled_license:
github: elorest/compiled_license
```
## Usage
```crystal
require "compiled_license"
2021-10-23 10:20:18 +00:00
puts CompiledLicense::LICENSES
2018-02-20 03:46:14 +00:00
```
2018-04-03 04:03:14 +00:00
Compile and run
2018-04-03 03:58:44 +00:00
```
2018-04-03 04:03:14 +00:00
$ crystal build src/testapp.cr
2018-04-03 03:58:44 +00:00
$ testapp --licenses
# Returns all licenses to stdout
```
2018-02-20 03:46:14 +00:00
## Contributing
1. Fork it ( https://github.com/elorest/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)
5. Create a new Pull Request
## Contributors
- [elorest](https://github.com/elorest) Isaac Sloan - creator, maintainer