FIN: readme docs

This commit is contained in:
JohnE 2015-06-25 10:59:34 -07:00
parent 42c8dfa493
commit f1b44dfbb8
3 changed files with 70 additions and 0 deletions

17
README Normal file
View File

@ -0,0 +1,17 @@
==================
DB Fingerprint
==================
-------------
INTRO
-------------
dbfp is a tool that will scan a sqlite database and generate a fingerprint.
The fingerprint is basically the database schema.
The fingerprint is stored to disk in JSON format.
-------------
BUILD
-------------

22
RELEASE_NOTES Normal file
View File

@ -0,0 +1,22 @@
---------------
Future Work
---------------
1. Fuzzy Logic database schema detection
------------
History
------------
version 0.9
-added JSON import
-added database schema comparison. currently only compares
version 0.8
-updated fingerprint to include SQLite database commands to create the tables
-updated fingerprint to include file metadata which is version of the fingerprint JSON file format
version 0.7
- export a database fingerprint to a JSON file

31
docs/README Normal file
View File

@ -0,0 +1,31 @@
==================
DB Fingerprint
==================
-------------
INTRO
-------------
dbfp is a tool that will scan a sqlite database and generate a fingerprint.
The fingerprint is basically the database schema.
The fingerprint is stored to disk in JSON format.
-------------
USAGE
-------------
***** ***** ***** *****
DB Fingerprint
***** ***** ***** *****
usage: main.py [-h] [-f FILE] [-j JSON] [-v]
Fingerprint a sqlite database based on its schema
optional arguments:
-h, --help show this help message and exit
-f FILE, --file FILE
-j JSON, --json JSON
-v, --verbose