Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tanmen/openapi-comment
https://github.com/tanmen/openapi-comment
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tanmen/openapi-comment
- Owner: tanmen
- Created: 2019-10-27T03:40:21.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-02-29T18:54:41.000Z (almost 5 years ago)
- Last Synced: 2024-05-02T05:16:31.271Z (8 months ago)
- Language: Ruby
- Size: 13.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# OpenapiComment
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/openapi_comment`. To experiment with that code, run `bin/console` for an interactive prompt.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'openapi_comment'
```And then execute:
$ bundle
Or install it yourself as:
$ gem install openapi_comment
## Usage
## 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/tanmen/openapi_comment.