diff --git a/.gitignore b/.gitignore index c27622e..14d36cf 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,8 @@ /lib /classes /checkouts +public/out +public/comportex.js pom.xml pom.xml.asc *.jar diff --git a/CHANGELOG.md b/CHANGELOG.md index 916c426..0732331 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,11 @@ ## [Unreleased] ### Changed +## [0.0.15-SNAPSHOT] - 2016-07-17 +### Added +- minimal Javascript API in new `js` namespace +- Javascript API demo in `public/comportex.js` + ## [0.0.14] - 2016-07-01 ### Changed - No more temporal pooling excitation. Instead, synapses from predicted diff --git a/README.md b/README.md index e859d9c..aec8c5a 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,12 @@ For an applied exploration of HTM using Comportex, try the essay [Predicting power consumptions with HTM](http://mrcslws.com/gorilla/?path=hotgym.clj) by Marcus Lewis. +## What is included? + +Comportex is written in [ClojureScript](https://github.com/clojure/clojurescript) and includes: +- a CLJS API in multiple namespaces (see below) +- a minimal Javascript API (WIP) in the `org.nfrac.comportex.js` namespace +- a group of samples/demos ## Documentation @@ -59,13 +65,26 @@ Or, for a better experience, check out the Notebook (browser-based REPL with super powers) in [Sanity](https://github.com/htm-community/sanity/). +## Javascript API (WIP) + +A minimal Javascript API is exposed. +There is a small demo which shows how to use this javascript API. + +Compile to javascript: + +`lein cljsbuild once` + +Load `public/comportexjs.html` in your browser. + +## Demos + +A list of demos can be found in `src/org/nfrac/comportex/demos/` ## Related projects * [Sanity](https://github.com/htm-community/sanity/) * [NuPIC](https://github.com/numenta/nupic/) - ## Hello * Get in touch via **HTM Forum** in the categories [HTM Theory](https://discourse.numenta.org/c/htm-theory) or [HTM Hackers](https://discourse.numenta.org/c/htm-hackers)