From: Shane J <nutratracker@protonmail.com>
Date: Fri, 8 Apr 2022 23:04:36 +0000 (-0400)
Subject: update README.rst
X-Git-Tag: 0.0.5~12
X-Git-Url: https://git.nutra.tk/v2?a=commitdiff_plain;h=4d4d404d61ad35cfbbd89625ebd29335aff67d58;p=nutratech%2Fnt-sqlite.git

update README.rst
---

diff --git a/README.rst b/README.rst
index 9b087e9..bedb9aa 100644
--- a/README.rst
+++ b/README.rst
@@ -2,7 +2,10 @@
  nt-sqlite
 ***********
 
-SQL and CSV files for setting up nutra portable SQL database.
+.. image:: https://api.travis-ci.com/nutratech/nt-sqlite.svg?branch=master
+    :target: https://travis-ci.com/github/nutratech/nt-sqlite
+
+Python, SQL and CSV files for setting up portable nt-sqlite database.
 
 See CLI:    https://github.com/nutratech/cli
 
@@ -12,7 +15,19 @@ Pypi page:  https://pypi.org/project/nutra
 Building the database
 #########################
 
-1. If you are committing schema design changes, bump the version for the corresponding tablename in ``tables.sql``.
+1. If you are committing database changes, add a line to :code:`data/version.csv` (e.g. :code:`id=4` is the latest in this case),
+
++-----+----------+-------------+------------------+
+| id  | version  | created     | notes            |
++=====+==========+=============+==================+
+| 1   | 0.0.0    | 2020-09-22  | initial release  |
++-----+----------+-------------+------------------+
+| 2   | 0.0.1    | 2021-05-21  | bump version     |
++-----+----------+-------------+------------------+
+| 3   | 0.0.2    | 2021-05-24  | remove guids     |
++-----+----------+-------------+------------------+
+| 4   | 0.0.3    | 2021-05-24  | general cleanup  |
++-----+----------+-------------+------------------+
 
 2. Create the database with,
 
@@ -20,7 +35,7 @@ Building the database
 
     python sql/__init__.py
 
-3. Verify the tables (again inside the SQL shell :code:`sqlite nutra.db`),
+3. Verify the tables (again inside the SQL shell :code:`sqlite3 nutra.sqlite`),
 
 .. code-block:: sql
 
@@ -28,7 +43,7 @@ Building the database
     SELECT * FROM versions;
     .exit
 
-4. If everything looks good, commit and copy any changes in SQL over to the ``cli`` (python) and ``nt-android`` (java) repos.
+4. If everything looks good, commit and update submodules in the ``cli`` (python) and ``nt-android`` (java) repos.
 
 
 Tables (Relational Design)