https://github.com/andrewaguiar/rladr
Simple cli tool to generate ADR (architecture decision records) notes
https://github.com/andrewaguiar/rladr
adr cli-tool documentation-tool
Last synced: about 1 year ago
JSON representation
Simple cli tool to generate ADR (architecture decision records) notes
- Host: GitHub
- URL: https://github.com/andrewaguiar/rladr
- Owner: andrewaguiar
- License: mit
- Created: 2019-01-31T15:53:18.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-02-24T15:33:13.000Z (over 7 years ago)
- Last Synced: 2024-04-25T10:02:23.635Z (about 2 years ago)
- Topics: adr, cli-tool, documentation-tool
- Language: Ruby
- Homepage:
- Size: 11.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Rladr
This gem gives you a simple too to generate adr files as markdown https://github.com/joelparkerhenderson/architecture_decision_record.
## Installation
Add this line to your application's Gemfile:
```ruby
group :development do
# ...
gem 'rladr'
end
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install rladr
## Usage
First you need to initialize the directory where ards will be stored
$ rladr init [directory]
Then create your adrs
$ rladr new
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 GitHub at https://github.com/andrewaguiar/rladr. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Rladr project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rladr/blob/master/CODE_OF_CONDUCT.md).