@josd/eyecode 0.0.0-stage → 0.1.3

package/LICENSE.md

@@ -0,0 +1,9 @@
+# MIT License
+
+### Copyright 2026 Jos De Roo, KNoWS office of IDLab, Ghent University - imec
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,3 +1,37 @@
-# Temporary Holding Version
+# <img src="assets/eye.png" alt="" width="48" height="48" align="absmiddle"> eyecode
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[![DOI](https://img.shields.io/badge/DOI-10.5281%2Fzenodo.23824021-blue.svg)](https://doi.org/10.5281/zenodo.23824021)
+[![npm](https://img.shields.io/npm/v/@josd/eyecode.svg)](https://www.npmjs.com/package/@josd/eyecode)
+
+eyecode is a **JavaScript rule language** with forward and backward reasoning
+and checkable proofs. You write facts and rules in plain JavaScript; eyecode
+draws conclusions, and every conclusion can come with a proof that a separate
+checker verifies against your program. It runs as a command-line program, a
+JavaScript library, and a browser application, with no dependencies.
+
+- **[Playground](https://eyereasoner.github.io/eyecode/playground)**: run
+  programs in your browser.
+- **[Guide](https://eyereasoner.github.io/eyecode/GUIDE)**: run programs,
+  write rules, check proofs, use the library, and develop eyecode.
+- **[Specification](https://eyereasoner.github.io/eyecode/SPEC)**: the
+  language, its canonical text, the proof format, and the C1–C7 checks.
+- **[Examples](examples/)**: 63 runnable programs, with their conclusions,
+  proofs and check reports, and a
+  [card deck](https://eyereasoner.github.io/eyecode/examples/deck/) for each.
+- **[Conformance suite](conformance/)**: 321 cases that test any
+  implementation of the specification through its command line.
+
+```js
+fact(type('socrates', 'human'))
+fact(subclass_of('human', 'mortal'))
+implies([type(S, A), subclass_of(A, B)], type(S, B))
+query(type(X, Y))
+```
+
+```sh
+node bin/eyecode.js examples/socrates.js
+node bin/eyecode.js --proof examples/socrates.js > /tmp/proof.js
+node bin/eyecode.js --check-proof /tmp/proof.js examples/socrates.js
+```
+
+MIT licensed; see [LICENSE.md](LICENSE.md).