Skip to content

Commit 62afd02

Browse files
author
Abhishek Singh
committed
v1.0.2 documentation
1 parent 889d3c3 commit 62afd02

1 file changed

Lines changed: 12 additions & 5 deletions

File tree

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@
66
[![Python 3.9](https://img.shields.io/badge/python-3.9-blue.svg)]((https://www.python.org/downloads/release/python-390/))
77
[![PyPy3.6](https://img.shields.io/badge/python-PyPy3.6-blue.svg)](https://www.pypy.org/index.html)
88

9-
Consider this README as a getting started guide. For detailed documentation refer [https://aosingh.github.io/sqlite_rx/](https://aosingh.github.io/sqlite_rx/)
9+
Consider this README as a getting started guide.
10+
11+
For detailed documentation refer [https://aosingh.github.io/sqlite_rx/](https://aosingh.github.io/sqlite_rx/)
1012

1113
# Introduction
1214

@@ -27,7 +29,7 @@ Key Features
2729
# Install
2830

2931
```commandline
30-
pip install sqlite_rx
32+
pip install -U sqlite_rx
3133
```
3234

3335
## Supported OS
@@ -39,11 +41,13 @@ pip install sqlite_rx
3941
- CPython 3.6, 3.7, 3.8, 3.9
4042
- PyPy3.6
4143

44+
4245
# Server
4346

4447
`SQLiteServer` runs in a single thread and follows an event-driven concurrency model (using `tornado's` event loop) which minimizes the cost of concurrent client connections. Following snippet shows how you can start the server process.
4548

4649
```python
50+
# server.py
4751
from sqlite_rx.server import SQLiteServer
4852

4953
def main():
@@ -64,6 +68,7 @@ if __name__ == '__main__':
6468

6569
```
6670

71+
6772
# Client
6873

6974
The following snippet shows how you can instantiate an `SQLiteClient` and execute a simple `CREATE TABLE` query.
@@ -81,7 +86,9 @@ with client:
8186

8287
```
8388

84-
```python
85-
{'error': None,
86-
'items': []}
89+
```text
90+
>> python client.py
91+
92+
{'error': None, 'items': []}
8793
```
94+

0 commit comments

Comments
 (0)