MANIFEST.in file

[datasette-pytables.git] / README.md

diff --git a/README.md b/README.md
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..76d79cd430d0c2dcdb34e41ffacb5b58bd8fdf48 100644 (file)
--- a/README.md
+++ b/README.md
@@ -0,0 +1,18 @@
+[![Build Status](https://travis-ci.org/PyTables/datasette-pytables.svg?branch=master)](https://travis-ci.org/PyTables/datasette-pytables)
+
+
+# datasette-pytables
+
+Datasette-PyTables provides a web interface and a JSON API for [PyTables](https://github.com/PyTables/PyTables) files, allowing them to be accessible for e.g. Javascript programs. It works in conjunction with [Datasette-Core](https://github.com/PyTables/datasette-core), a trivial fork of the original [Datasette](https://github.com/simonw/datasette), which provides a web interface for SQLite files.  This fork is able to work with SQLite files, like the original project, but can accept external connectors for any kind of database files, so you can develop your own connector for your favourite data container if you want (read [developers doc](https://github.com/PyTables/datasette-pytables/blob/master/DEVELOPERS.md)).
+
+## Installation
+
+Run `pip install datasette-pytables` to install both the forked version of Datasette and the PyTables connector. Easy as pie!
+
+## How to serve PyTables files
+
+    datasette serve path/to/data.h5
+
+This will start a web server on port 8001; then you can access to your data visiting [http://localhost:8001/](http://localhost:8001/)
+
+Read the [Datasette documentation](http://datasette.readthedocs.io/en/latest/) for more advanced options.