README.md in dualcone-0.0.1 vs README.md in dualcone-1.0.0
- old
+ new
@@ -1,29 +1,15 @@
# Dualcone
-[![CircleCI](https://circleci.com/gh/t-richards/dualcone.svg?style=svg)](https://circleci.com/gh/t-richards/dualcone)
+![Test](https://github.com/t-richards/dualcone/actions/workflows/test.yml/badge.svg)
Dualcone is a Ruby source code protection system. Dualcone uses symmetric encryption to protect your source code.
Dualcone is a self-contained gem. It brings along its own copy of the lightweight cryptographic library, [libhydrogen][libhydrogen].
Dualcone supports GNU + Linux and other Unix-like operating systems. Windows is not supported.
-## Roadmap
-
-### Part 1
- - [x] Key generation: `Dualcone.generate_key`
- - [x] Encrypted code running: `Dualcone.run(code)`
- - [x] Encrypted code generation: `Dualcone.encrypt(path)`
- - [x] Specs passing
-
-### Part 2
- - [x] Runnable trivial ruby script
- - [ ] Runnable non-trivial ruby script
- - [ ] Runnable sinatra app
- - [ ] Runnable rails app
-
## Installation
Add this gem to your application's Gemfile:
```ruby
@@ -101,16 +87,23 @@
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 `bin/rake install`. To release a new version, update the version number in `version.rb`, and then run `bin/rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org][rubygems].
+## Roadmap
+
+ - [x] Runnable trivial ruby script
+ - [ ] Runnable non-trivial ruby script
+ - [ ] Runnable sinatra app
+ - [ ] Runnable rails app
+
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/t-richards/dualcone.
## License
-The gem is available as open source under the terms of the [MIT License][mit-license].
+The gem is available as open source under the terms of the [ISC License][isc-license].
[libhydrogen]: https://github.com/jedisct1/libhydrogen
-[mit-license]: https://opensource.org/licenses/MIT
+[isc-license]: LICENSE.txt
[rubygems]: https://rubygems.org