Skip to content

Commit d11e4dd

Browse files
committed
Fix minor bugs/changes in README.md
Fixes #77
1 parent 1cf987d commit d11e4dd

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

README.md

+20-20
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ If you like to be anonymous when searching things, want to archive tweets or mes
2121
- omit authentication enforcment for API requests on the twitter plattform
2222
- share tweets and tweet archives with other loklak users
2323
- search anonymously on your own search portal
24-
- create your own tweet search portal or statistical evaluations, i.e.:..
24+
- create your own tweet search portal or statistical evaluations
2525
- use Kibana to analyze large amounts of tweets as source for statistical data.
2626

2727
--------------------------------------------
@@ -53,9 +53,9 @@ To create a loklak object you can assign the `Loklak()` object to a variable.
5353
eg. `l = Loklak()`
5454
This creates an objects whose backend loklak server is `http://loklak.org/`
5555

56-
If you want to set this API to use your own server, you can now define it by doing
57-
`l = Loklak('http://192.168.192.5:9000/')` for example or pass a URL to it as
58-
`l = Loklak('http://loklak-super-cluster.mybluemix.net/')
56+
If you want to set this API to use your own server, you can now define it by doing
57+
`l = Loklak('http://192.168.192.5:9000/')` for example or pass a URL to it as
58+
`l = Loklak('http://loklak-super-cluster.mybluemix.net/')`
5959

6060
Note the trailing `/` is important and so is `http://`
6161

@@ -196,11 +196,11 @@ Using the class method `settings()` to returns a json of the settings being used
196196

197197
##### Hello test - Check if the server is responding properly and is online
198198

199-
Using the object created above `l.hello()` returns a json response of the status of the server
199+
Using the object created above `l.hello()` returns a json response of the server status
200200

201201
When the server is online, the json should read
202202
```json
203-
{'status': 'ok'}
203+
{"status": "ok"}
204204
```
205205

206206
##### Peers - API To find out the loklak peers
@@ -215,15 +215,16 @@ What this can do ?
215215
- Fetch the details of the user along with number of their followes and following
216216
- Fetch only the followers / following of a particular user
217217

218-
Query Structure: `l.user(<username>,<followers count>,<following count>)`
218+
Query Structure: `l.user(<username>, <followers count>, <following count>)`
219219

220-
`<username>` is a string, eg. `'loklak_app'`
220+
`<username>` is a string, e.g. `'loklak_app'`
221221
`<followers count>` and `<following count>` is a numeric or a string or `None`
222222

223-
eg. `l.user('loklak_app')`
224-
eg. `l.user('loklak_app',1000)` - 1000 followers of `loklak_app`
225-
eg. `l.user('loklak_app',1000,1000)` - 1000 followers and following of `loklak_app`
226-
eg. `l.user('loklak_app',None,1000)` - 1000 following of `loklak_app`
223+
e.g.
224+
1. `l.user('loklak_app')`
225+
2. `l.user('loklak_app', 1000)` - 1000 followers of `loklak_app`
226+
3. `l.user('loklak_app', 1000, 1000)` - 1000 followers and following of `loklak_app`
227+
4. `l.user('loklak_app', None, 1000)` - 1000 following of `loklak_app`
227228

228229
##### Accounts API
229230
LOCALHOST ONLY, Loklak server running on port `localhost:9000`
@@ -233,15 +234,15 @@ To query the user account details of the data within the loklak server, use
233234

234235
To update the user details within the server, package a `json` object with the following parameters and other parameters which needs to be pushed to the server and use the `action=update` where `action` is the 2nd parameter of the `account()` api
235236

236-
`l.account('name','update','{ json object }')`
237+
`l.account('name', 'update', '{ json object }')`
237238

238239
##### Search API
239240

240241
Public search API for the scraped tweets from Twitter.
241242

242-
Query structure: `search('querycontent','since date','until date', 'from a specific user', '# of tweets')`
243+
Query structure: `search('querycontent', 'since date', 'until date', 'from a specific user', '# of tweets')`
243244

244-
eg. l.search('doctor who')
245+
e.g. `l.search('doctor who')`
245246

246247
A search result in json looks as follows.
247248
```json
@@ -296,7 +297,7 @@ A search result in json looks as follows.
296297

297298
Mentioning the Since and Until dates
298299

299-
eg. `l.search('sudheesh001', '2015-01-10', '2015-01-21')`
300+
e.g. `l.search('sudheesh001', '2015-01-10', '2015-01-21')`
300301

301302
Which results in a json as follows
302303
```json
@@ -366,17 +367,16 @@ Valid parameters for `since` and `until` can also be `None` or any `YMD` date fo
366367

367368
The `from a specific user` parameter makes sure that the results obtained for the given query are only from a specific user.
368369

369-
`l.search('doctor who', '2015-01-10', '2015-01-21','0rb1t3r')`
370+
e.g. `l.search('doctor who', '2015-01-10', '2015-01-21','0rb1t3r')`
370371

371372
The `# of tweets` parameter is how many tweets will be returned.
372373

373-
`l.search('avengers', None, None, 'Iron_Man', 3)`
374+
e.g. `l.search('avengers', None, None, 'Iron_Man', 3)`
374375

375376
##### Aggregations API
376377

377378
##### GeoLocation API
378379

379380
Loklak allows you to fetch required information about a country or city.
380381

381-
eg. `l.geocode(['Barcelona'])`
382-
eg. `l.geocode(['place1','place2'])`
382+
e.g. `l.geocode(['Barcelona'])`, `l.geocode(['place1', 'place2'])`

0 commit comments

Comments
 (0)