chores: 1.3 release

Signed-off-by: Emanuel Calvo <[email protected]>

CHANGELOG.md

@@ -2,10 +2,17 @@
 
 Notable changes to pgqueries.
 
-## Release number - [yyyy-mm-dd]
+## v1.3 - [2023-06-14]
 
 ### Added
 
-### Changed
+- artifact_builder builds NDJSON format, for easy import into Postgres using COPY command.
+### Fixed
 
-### Fixed
+- Fixes to the artifact_builder
+
+## v1.0 - v1.2
+
+### Added
+
+- Functional artifact_builder

README.md

@@ -30,8 +30,6 @@ The hierarchical tree is compound by:
 sql/<category>/file.[sql|md]
 ```
 
-
-
 ## SQL formatting and practices
 
 Rule 1:
@@ -44,6 +42,13 @@ Rule 2:
 
 > First comment line is mandatory. Minimal accepted documentation.
 
+## Indexer
+
+> This is currently under development.
+
+This repository includes and indexer tool (artifact_builder) that builds json artifacts to be 
+easily imported into Postgres using NDJSON format. 
+
 ## Testing
 
 TODO

artifact_builder/README.md

@@ -4,14 +4,25 @@ This section builds a JSON map of the SQL and MD files present on the repository
 
 ## Execution
 
+Load virtual env:
 
 ```bash
-python3 artifact_builder/ -D sql -v | jq '.search_query'
+python3 -m venv venv
+source venv/bin/activate
+pip3 install -r requirements.txt
 ```
 
-Default output: index.json (with `--output`).
+The folowing allows you to index and search:
+
+```bash
+python3 artifact_builder/ -D sql -E -v | jq '.search_query'
+```
+
+See `python3 artifact_builder/ -h` for more information.
+
+Default output: index.json (with `--output`) and `--ouput-ndjson` (`ndindex.json`).
 
 
-## Modules [potentially] used
+## TODO 
 
-[Dataclasses](https://github.com/lidatong/dataclasses-json)
+Modules [potentially] beneficial: [Dataclasses](https://github.com/lidatong/dataclasses-json)