Skip to content

Commit

Permalink
#1 documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
josuebrunel committed Aug 16, 2014
1 parent d9b5371 commit 0a393da
Showing 1 changed file with 10 additions and 14 deletions.
24 changes: 10 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ LokingYQL is a Yahoo Query Language Wrapper written in Python
version
=======

0.5
***0.5***

installation
============
Expand All @@ -25,23 +25,20 @@ how to use
>>> yql = lokingyql.LokingYQL()
>>> yql.diagnostics = True # To turn diagnostics on
```

#
Methods
-------

* use()
-------
- use(data_provider_url)
------------------------

Changes the data provider

```python
>>> yql.use('http://myserver.com/mytables.xml')
```


* rawQuery()
------------
- rawQuery(query)
-----------------

Allows you to directly type your query

Expand All @@ -50,8 +47,8 @@ Allows you to directly type your query
>>> # deal with the response
```

* select(table, fields).where(filters, ...)
-----------------------
- select(table, fields).where(filters, ...)
-------------------------------------------

Select a table i.e *weather.forecast*.
If *table* not provided, it will use the default table. If there's no such thing as a default table, it will raise a *NoTableSelectedError*
Expand All @@ -63,19 +60,18 @@ If *table* not provided, it will use the default table. If there's no such thing
>>> ...
```

* create()
- create()
----------

* insert()
- insert()
----------

* update()
- update()
----------

* delete()
----------

Voila



Expand Down

0 comments on commit 0a393da

Please sign in to comment.