Skip to content

Commit 4f274a8

Browse files
Merge pull request #151 from alixsep/alixsep-contribution-01
Fix README.md typos and issues
2 parents 41e6894 + 3914bb6 commit 4f274a8

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
There was no free Dictionary API on the web when I wanted one for my friend, so I created one.
44

55
## Important Note
6-
The API usage has been ramping up radidly making it difficult for me to keep the server running due to increased AWS costs.
6+
The API usage has been ramping up rapidly, making it difficult for me to keep the server running due to increased AWS costs.
77

88
Your support directly helps the development of Dictionary API and keeps the server running.
99

@@ -15,11 +15,11 @@ Your support directly helps the development of Dictionary API and keeps the serv
1515

1616
The basic syntax of a URL request to the API is shown below:
1717

18-
https://api.dictionaryapi.dev/api/<--version-->/entries/en/<--word-->
18+
`https://api.dictionaryapi.dev/api/<--version-->/entries/en/<--word-->`
1919

2020
As an example, to get definition of English word **hello** using _v2_, you can send request to
2121

22-
https://api.dictionaryapi.dev/api/v2/entries/en/hello, result returned will be,
22+
`https://api.dictionaryapi.dev/api/v2/entries/en/hello` and the result returned will be:
2323

2424
```json
2525
[
@@ -76,7 +76,7 @@ https://api.dictionaryapi.dev/api/v2/entries/en/hello, result returned will be,
7676
```
7777

7878
### Regarding V1 Version
79-
The API earlier use to send response as shown below, but this structure of response was found out to be difficult to work with (you can take a look at these tickets [#32](https://github.com/meetDeveloper/freeDictionaryAPI/issues/32) and [#4](https://github.com/meetDeveloper/freeDictionaryAPI/issues/4)), based on feedback in these tickets I have updated the API to _v2_ version. That said, _v1_ version will always be supported for backward compatibility.
79+
The API earlier used to send response as shown below, but this structure of response was found out to be difficult to work with (you can take a look at these tickets [#32](https://github.com/meetDeveloper/freeDictionaryAPI/issues/32) and [#4](https://github.com/meetDeveloper/freeDictionaryAPI/issues/4)), based on feedback in these tickets I have updated the API to _v2_ version. But _v1_ version will always be supported for backward compatibility.
8080

8181
```json
8282
[

0 commit comments

Comments
 (0)