Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/willnet/prmd-rails
https://github.com/willnet/prmd-rails
Last synced: 16 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/willnet/prmd-rails
- Owner: willnet
- License: mit
- Created: 2016-03-12T01:22:27.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2016-03-12T01:22:38.000Z (almost 9 years ago)
- Last Synced: 2025-01-02T23:33:30.089Z (23 days ago)
- Language: Ruby
- Size: 7.81 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Prmd::Rails
JSON Schema tools for Rails Application, prmd wrapper
**Now this gem is under construction**
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'prmd-rails'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install prmd-rails
## Usage
```
rake json_schema # Combine, verify, and generate documantation
rake json_schema:combine # Combine schemas
rake json_schema:doc # Generate documentation
rake json_schema:verify # Verify schemas
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/willnet/prmd-rails. 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](http://opensource.org/licenses/MIT).