Skip to content

Commit c513714

Browse files
committed
Updating Readme
1 parent acab89f commit c513714

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

README.md

+12-8
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Geek-Jokes
22

3-
## A Flask RESTful API to get random geek jokes
3+
## A RESTful API to get random geek jokes written in Flask
44
[![forthebadge](http://forthebadge.com/images/badges/made-with-python.svg)](http://forthebadge.com)
55
[![forthebadge](http://forthebadge.com/images/badges/gluten-free.svg)](http://forthebadge.com)
66

@@ -12,36 +12,36 @@ The Geek Jokes api is for any developer needing some random (geeky) jokes in the
1212

1313
## URL
1414
```
15-
GET: https://geek-jokes.sameerkumar.website/api
15+
GET: https://geek-jokes.sameerkumar.website/api?format=json
1616
```
1717

1818
## Usage
1919
Just do a GET request on the API URL.
2020
```
21-
GET: https://geek-jokes.sameerkumar.website/api
21+
GET: https://geek-jokes.sameerkumar.website/api?format=json
2222
```
2323

2424
## Examples
2525

2626
### cURL
2727
```
2828
curl -X GET \
29-
'https://geek-jokes.sameerkumar.website/api'
29+
'https://geek-jokes.sameerkumar.website/api?format=json'
3030
```
3131

3232
### Python
3333
```Python
3434
import requests
3535

36-
requests.get('https://geek-jokes.sameerkumar.website/api')
36+
requests.get('https://geek-jokes.sameerkumar.website/api?format=json')
3737
```
3838

3939
### Node.js (es6)
4040
```Javascript
4141
var request = require('request');
4242

4343
let options = {
44-
url: 'https://geek-jokes.sameerkumar.website/api',
44+
url: 'https://geek-jokes.sameerkumar.website/api?format=json',
4545
method: 'GET'
4646
}
4747

@@ -51,10 +51,14 @@ request(options, (err, response, body) => {
5151
});
5252
```
5353
### Any browser
54-
visit the url: https://geek-jokes.sameerkumar.website/api to get a joke. Press refresh button for more jokes.
54+
visit the url: https://geek-jokes.sameerkumar.website/api?format=json to get a joke. Press refresh button for more jokes.
5555

5656
## License
5757
MIT
5858

5959
## Contact
60-
Contact me here: [sameer18051998@gmail.com](mailto:sameer18051998@gmail.com)
60+
Contact: [sam@sameerkumar.website](mailto:sam@sameerkumar.website)
61+
62+
## Author
63+
Sameer Kumar
64+
https://sameerkumar.website

runtime.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
python-3.6.6
1+
python-3.6.10

0 commit comments

Comments
 (0)