readme and changelog

3 files changed, 75 insertions, 56 deletions

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..1240091
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,20 @@
+
+# Changelog
+
+## 0.23.03 (Initial release)
+
+### Added
+
+- Information extraction pipeline essentials
+- Filematcher to check the file type and format
+- Index app to run the IE pipeline
+- Initial documentation
+- Basic extractors
+  - Constant
+  - Filename
+  - Filesize
+  - Previews
+- Image extractors
+  - Exif
+  - Regionally dominant colors
+
diff --git a/README b/README
deleted file mode 100644
index 3326196..0000000
--- a/README
+++ /dev/null
@@ -1,56 +0,0 @@
-
-Black Star Information Extraction
-=================================
-
-
-### Developer tools setup
-
-#### Test coverage (coverage)
-
-Resources:
-* https://coverage.readthedocs.io/en/6.5.0/index.html
-* https://nedbatchelder.com/blog/200710/flaws_in_coverage_measurement.html
-
-Commands:
-$ pip install coverage
-$ coverage run ; coverage html ; xdg-open .htmlcov/index.html
-
-
-
-#### Static code analysis (pylint)
-
-Resources:
-* https://github.com/PyCQA/pylint
-* https://pylint.org/
-* https://pylint.pycqa.org/en/latest/user_guide/messages/messages_overview.html#messages-overview
-
-Commands:
-$ pip install pylint
-$ pylint bsie
-
-
-
-#### Type analysis (mypy)
-
-Resources:
-* https://github.com/python/mypy
-* https://mypy.readthedocs.io/en/stable/
-
-Commands:
-$ pip install mypy
-$ mypy
-
-
-
-#### Documentation (sphinx)
-
-Resources:
-* 
-* 
-
-Commands:
-$ pip install ...
-$ 
-
-
-
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..85cb68f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,55 @@
+
+# Black Star Information Extraction
+
+The Black Star Information Extraction (BSIE) package provides a pipeline
+to extract metadata and content-derived features from files and stores
+that information in a BSFS storage.
+
+## Installation
+
+You can install BSIE via pip:
+
+    $ pip install --extra-index-url https://pip.bsfs.io bsie
+
+
+## Development
+
+Set up a virtual environment:
+
+    $ virtualenv env
+    $ source env/bin/activate
+
+Install bsie as editable from the git repository:
+
+    $ git clone https://git.bsfs.io/bsie.git
+    $ cd bsie
+    $ pip install -e .
+
+Install the following additional packages besides BSIE:
+
+    $ pip install coverage mypy pylint
+    $ pip install rdflib requests types-PyYAML
+    $ pip install sphinx sphinx-copybutton furo
+    $ pip install build
+
+To ensure code style discipline, run the following commands:
+
+    $ coverage run ; coverage html ; xdg-open .htmlcov/index.html
+    $ pylint bsie
+    $ mypy
+
+To build the package, do:
+
+    $ python -m build
+
+To run only the tests (without coverage), run the following command from the **test folder**:
+
+    $ python -m unittest
+
+To build the documentation, run the following commands from the **doc folder**:
+
+    $ sphinx-apidoc -f -o source/api ../bsie/ --module-first -d 1 --separate
+    $ make html
+    $ xdg-open build/html/index.html
+
+