blob: c2482b41f8ea094c4c3a1eebfc95c74284ee83ca (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
|
# Spandx
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/spandx`. To experiment with that code, run `bin/console` for an interactive prompt.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'spandx'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install spandx
## Usage
TODO: Write usage instructions here
```ruby
catalogue = Spandx::Catalogue.latest
catalogue.each do |license|
puts license.inspect
end
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/cibuild` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitLab at https://gitlab.com/xlgmokha/spandx.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
