Skip to content

Commit

Permalink
Mention about live documentation of the gem
Browse files Browse the repository at this point in the history
  • Loading branch information
kupolak committed Dec 20, 2023
1 parent 7362159 commit acb4162
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
- [Flights by Bounds](#flights-by-bounds)
- [Airline Logo](#airline-logo)
- [Country Flag](#country-flag)
- [Documentation](#documentation)
- [Development](#development)
- [Contributing](#contributing)
- [License](#license)
Expand Down Expand Up @@ -265,6 +266,10 @@ FlightRadar.country_flag("Poland")
"https://www.flightradar24.com/static/images/data/flags-small/poland.gif"
```

## Documentation

Live documentation of the gem is available [at this GitHub page](https://kupolak.github.io/flight_radar/).

## Development

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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
Expand Down

0 comments on commit acb4162

Please sign in to comment.