Skip to content

Commit 0cc9eb4

Browse files
author
Evgeny Khlopin
committed
Update README.md
1 parent e31c13f commit 0cc9eb4

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This application uses the next gems:
1414
Apipie-rails is a DSL and Rails engine for documenting your RESTful API. Instead of traditional use of `#comments`, Apipie lets you describe the code, through the code.
1515

1616
### Getting started
17-
Add gem to your Gemfile
17+
Add the gem to your Gemfile
1818
```ruby
1919
# Gemfile
2020
gem 'apipie-rails'
@@ -73,7 +73,7 @@ def create
7373
end
7474
end
7575
```
76-
Thats all! Follow the link [localhost:3000/apipie](http://localhost:3000/apipie) to check the generated API documentation.
76+
That's all! Follow the link [localhost:3000/apipie](http://localhost:3000/apipie) to check the generated API documentation.
7777
<p align="center">
7878
<img src="public/images/screen1.png" style="border: 1px solid grey">
7979
</p>
@@ -84,7 +84,7 @@ Thats all! Follow the link [localhost:3000/apipie](http://localhost:3000/apipie)
8484
For more information please check out [apipie gem documentation]([https://github.com/Apipie/apipie-rails#documentation)
8585

8686
## DOX
87-
Dox generates API documentation from Rspec controller/request specs in a Rails application. It formats the output of the tests in the [API Blueprint](https://apiblueprint.org/) format.
87+
Dox generates API documentation from RSpec controller/request specs in a Rails application. It formats the output of the tests in the [API Blueprint](https://apiblueprint.org/) format.
8888

8989
### Getting started
9090
Add this line into your Gemfile:
@@ -95,7 +95,7 @@ end
9595
```
9696
Run `bundle install`
9797

98-
Require Dox in the `rails_helper` and configure rspec:
98+
Require Dox in the `rails_helper` and configure RSpec:
9999
```ruby
100100
# spec/rails_helper.rb
101101

@@ -218,7 +218,7 @@ namespace :api do
218218
end
219219
end
220220
```
221-
Now the documentation can be generated by `rake api:doc:generate` command
221+
Now the documentation can be generated by `rake api:doc:generate` command.
222222

223223
### Renderers
224224
You can render the HTML by yourself with one of the renderers:
@@ -230,7 +230,7 @@ Both of them support multiple themes and template customization.
230230
Or you can just take your generated markdown and host your documentation on [Apiary.io](https://apiary.io/)
231231

232232
#### Apiary
233-
To use apiary you need to install [apiary gem](https://github.com/apiaryio/apiary-client)
233+
To use apiary, you need to install [apiary gem](https://github.com/apiaryio/apiary-client)
234234
```ruby
235235
# Gemfile
236236

@@ -263,7 +263,7 @@ namespace :api do
263263
end
264264
```
265265

266-
Now you have a well-formatted documentation generated out of the specs to share with your team:
266+
Now you have well-formatted documentation generated out of the specs to share with your team:
267267

268268
<p align="center">
269269
<img src="public/images/screen4.png" style="border: 1px solid grey">
@@ -272,11 +272,11 @@ Now you have a well-formatted documentation generated out of the specs to share
272272
<img src="public/images/screen5.png" style="border: 1px solid grey">
273273
</p>
274274

275-
You can find more info about dox and apiary here:
275+
You can find more info about Dox and Apiary here:
276276
* [https://github.com/infinum/dox](https://github.com/infinum/dox)
277277
* [https://github.com/apiaryio/apiary-client](https://github.com/apiaryio/apiary-client)
278278

279-
## Rspec api documentation
279+
## RSpec API documentation
280280

281281
Gem [rspec_api_documentation](https://github.com/zipmark/rspec_api_documentation) generates API documentation from RSpec like the [dox gem](https://github.com/infinum/dox).
282282

@@ -330,7 +330,7 @@ rake docs:generate
330330
```
331331
Now you can find your documentation here `doc/api/index.html`.
332332

333-
It look like this:
333+
It looks like this:
334334
<p align="center">
335335
<img src="public/images/screen6.png" style="border: 1px solid grey">
336336
</p>

0 commit comments

Comments
 (0)