velaris-lang 4.3.0 → 4.3.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +25 -2
  2. package/package.json +2 -1
package/README.md CHANGED
@@ -23,12 +23,35 @@ console.log(result.ok, result.output, result.refusedEffect);
23
23
 
24
24
  Velaris is a language where a function's signature declares its types,
25
25
  the effects it may perform, whether it can fail, and promises a theorem
26
- prover checks before the program runs. This package is a thin wrapper:
27
- the compiler is a Python package, so `pip install velaris-lang` once.
26
+ prover checks before the program runs. This package is a thin wrapper
27
+ around that compiler.
28
28
 
29
29
  Not a security boundary - allowing `ffi` grants everything Python can
30
30
  do. It is a real guard for running a script a model wrote.
31
31
 
32
+ ## The compiler
33
+
34
+ The compiler itself is a Python package. This wrapper calls it, so
35
+ install it once:
36
+
37
+ ```
38
+ pip install velaris-lang
39
+ ```
40
+
41
+ Two optional pieces are worth having:
42
+
43
+ ```
44
+ pip install "velaris-lang[full]"
45
+ ```
46
+
47
+ That adds `z3-solver`, which proves a function's promises before the
48
+ program runs instead of leaving them to be checked as it goes, and
49
+ `llvmlite`, which compiles pure integer and float code to native code
50
+ instead of interpreting it. Neither is required. Without them Velaris
51
+ runs fully interpreted and checks promises while running - it prints
52
+ `note: llvmlite is not installed - running fully interpreted` and
53
+ carries on, refusing effects outside the budget exactly the same way.
54
+
32
55
  [Documentation](https://gowrishankar-infra.github.io/velaris-lang/) ·
33
56
  [Playground](https://gowrishankar-infra.github.io/velaris-lang/playground.html) ·
34
57
  [Source](https://github.com/gowrishankar-infra/velaris-lang)
package/package.json CHANGED
@@ -1,6 +1,7 @@
1
1
  {
2
2
  "name": "velaris-lang",
3
- "version": "4.3.0",
3
+ "version": "4.3.3",
4
+ "mcpName": "io.github.gowrishankar-infra/velaris",
4
5
  "description": "Run code you did not write. A language where a signature declares its effects and promises, and the runtime refuses anything you did not allow.",
5
6
  "keywords": [
6
7
  "velaris",