Skip to content

Commit

Permalink
Switch readme to markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
amyreese committed Apr 5, 2018
1 parent 8cd4ed7 commit 9ace99e
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 14 deletions.
2 changes: 1 addition & 1 deletion MANIFEST.in
@@ -1 +1 @@
include README LICENSE
include README.md LICENSE
22 changes: 12 additions & 10 deletions README.rst → README.md
@@ -1,27 +1,29 @@
aiosqlite
=========

AsyncIO bridge to the standard ``sqlite3`` module for Python 3.5+
AsyncIO bridge to the standard `sqlite3` module for Python 3.5+

.. image:: https://travis-ci.org/jreese/aiosqlite.svg?branch=master
:target: https://travis-ci.org/jreese/aiosqlite
[![build status](https://travis-ci.org/jreese/aiosqlite.svg?branch=master)](https://travis-ci.org/jreese/aiosqlite)
[![version](https://img.shields.io/pypi/v/aiosqlite.svg)](https://pypi.python.org/pypi/aiosqlite)
[![license](https://img.shields.io/pypi/l/aiosqlite.svg)](https://github.com/jreese/aiosqlite/blob/master/LICENSE)
[![code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)


Install
-------

aiosqlite is compatible with Python 3.5 and newer.
You can install it from PyPI with the following command::
You can install it from PyPI with the following command:

$ pip install aiosqlite


Usage
-----

aiosqlite replicates the standard ``sqlite3`` module, but with async versions
aiosqlite replicates the standard `sqlite3` module, but with async versions
of all the standard connection and cursor methods, and context managers for
automatically closing connections::
automatically closing connections:

async with aiosqlite.connect(...) as db:
await db.execute('INSERT INTO some_table ...')
Expand Down Expand Up @@ -51,7 +53,7 @@ async iterators to query results.
License
-------

aiosqlite is copyright John Reese, and licensed under the MIT license.
I am providing code in this repository to you under an open source license.
This is my personal repository; the license you receive to my code
is from me and not from my employer. See the ``LICENSE`` file for details.
aiosqlite is copyright [John Reese](https://jreese.sh), and licensed under the
MIT license. I am providing code in this repository to you under an open source
license. This is my personal repository; the license you receive to my code
is from me and not from my employer. See the `LICENSE` file for details.
3 changes: 0 additions & 3 deletions makefile
@@ -1,6 +1,3 @@
README:
cp README.rst README

build:
python3 setup.py build

Expand Down

0 comments on commit 9ace99e

Please sign in to comment.