aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorbnewbold <bnewbold@robocracy.org>2012-04-10 20:58:13 -0400
committerbnewbold <bnewbold@robocracy.org>2012-04-11 10:58:08 -0400
commit78b207a40436d0c15a2b806171914d802cd20661 (patch)
tree730d02b32e5d54b2512a319d7ced34ad8ce3aacf /README
parent3c7a4451e62d27bbe9dc8eb2c16e2ff5607d1b04 (diff)
downloadbommom-78b207a40436d0c15a2b806171914d802cd20661.tar.gz
bommom-78b207a40436d0c15a2b806171914d802cd20661.zip
tests passing
Diffstat (limited to 'README')
-rw-r--r--README21
1 files changed, 21 insertions, 0 deletions
diff --git a/README b/README
index 275776c..a1ec91f 100644
--- a/README
+++ b/README
@@ -12,3 +12,24 @@ BomMom: A web publishing/wiki system for electronics Bill of Materials (BOM)
A work in progress as of early April 2012.
+### Instructions
+
+Install golang compiler and run `go build` in this directory, then run the
+`bommom` command to list available commands and options.
+
+### Intended Initial Features
+
+ - SQL-backed datastore for BOMs and web authentication
+ - file-backed datastore for BOMs
+ - import/export to .csv and JSON
+
+### Potential Later Features
+
+ - auto-submit orders to major distributors
+ - current inventory tracking
+ - per-part statistics (eg, most popular parts)
+ - REST API
+ - git-backed BomStore
+ - git post-commit hooks and/or github integration
+ - plugins for CAD software (Eagle, KiCad, etc)
+