Skip to content

Commit c16b647

Browse files
committed
Update readme
1 parent 552b901 commit c16b647

File tree

1 file changed

+3
-10
lines changed

1 file changed

+3
-10
lines changed

README.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
# Grape::Swagger::Representable
1+
# GrapeSwagger::Representable [![Build Status](https://travis-ci.org/Bugagazavr/grape-swagger-representable.svg)](https://travis-ci.org/Bugagazavr/grape-swagger-representable)
22

3-
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/grape/swagger/representable`. To experiment with that code, run `bin/console` for an interactive prompt.
4-
5-
TODO: Delete this and the text above, and describe your gem
3+
A simple grape-swagger adapter to allow parse representers as response model
64

75
## Installation
86

@@ -20,21 +18,16 @@ Or install it yourself as:
2018

2119
$ gem install grape-swagger-representable
2220

23-
## Usage
24-
25-
TODO: Write usage instructions here
26-
2721
## Development
2822

29-
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.
23+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` to run the tests. You can also run `bin/pry` for an interactive prompt that will allow you to experiment.
3024

3125
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).
3226

3327
## Contributing
3428

3529
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/grape-swagger-representable.
3630

37-
3831
## License
3932

4033
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)