README.md in spandx-0.12.3 vs README.md in spandx-0.13.0
- old
+ new
@@ -1,12 +1,16 @@
-# Spandx ![badge](https://github.com/mokhan/spandx/workflows/ci/badge.svg)
+![Spandx](logo.gif)
+*Logo courtesy of [@speasley](https://github.com/speasley)*
+
+# Spandx ![badge](https://github.com/spandx/spandx/workflows/ci/badge.svg)
+
A ruby API for interacting with the https://spdx.org software license catalogue.
This gem includes a command line interface to scan a software project for the
software licenses that are associated with each dependency in the project.
`spandx` leverages an offline cache of software licenses for known dependencies.
-The offline cache allows spandx to perform a truly airgap friendly scan of software
+The offline cache allows Spandx to perform an air gap friendly scan of software
projects.
### Supported project types
Spandx can work with following language's package managers. It utilises lock files generated by package managers to find dependencies.
@@ -40,11 +44,11 @@
## Usage
### Command line interface
-The command line interface supports operations to build and fetch the latest offline index.
+The command line interface supports operations to fetch the latest pre-built cache.
See the help for each subcommand for more information on how to use the command.
```bash
モ spandx
Commands:
@@ -60,23 +64,23 @@
モ spandx scan java/pom.xml
モ spandx scan python/Pipfile.lock
モ spandx scan ruby/Gemfile.lock
```
-To activate airgap mode use the `--airgap` option:
+To activate air gap mode use the `--airgap` option:
```bash
モ spandx scan dotnet/application.sln --airgap
モ spandx scan ruby/Gemfile.lock --airgap
```
-Airgap mode assumes that an offline cache has been placed in `$HOME/.local/share/`.
+Air gap mode assumes that an offline cache has been placed in `$HOME/.local/share/`.
To fetch the latest offline cache:
```bash
-モ spandx index update
+モ spandx pull
```
### Ruby API
To fetch the latest version of the catalogue data from [SPDX](https://spdx.org/licenses/licenses.json).
@@ -104,10 +108,10 @@
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 GitHub at https://github.com/mokhan/spandx.
+Bug reports and pull requests are welcome on GitHub at https://github.com/spandx/spandx.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).