Skip to content

Commit 18dff6f

Browse files
committed
docs: drop ANSI block-letter banner, add npm install + landing-page install section
- README: removed the ASCII 3D 'DHAMAKA' fallback (didn't render well), added the npm install one-liner and shields.io badges right under the SVG banner, split the quickstart into 'just want to use the SDK?' (npm install) and 'want to hack on the runtime?' (clone + build.sh). - Playground landing page: added an Install section with the npm command, a minimal SmartField snippet, and links to npm + GitHub Packages.
1 parent 8c8ea87 commit 18dff6f

2 files changed

Lines changed: 39 additions & 12 deletions

File tree

README.md

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,11 @@
1818

1919
<br/>
2020

21-
<sub>The banner above is animated — the block letters cycle through a rainbow gradient and the stars pulse. Static fallback:</sub>
22-
21+
```bash
22+
npm install dhamaka
2323
```
24-
██████╗ ██╗ ██╗ █████╗ ███╗ ███╗ █████╗ ██╗ ██╗ █████╗
25-
██╔══██╗██║ ██║██╔══██╗████╗ ████║██╔══██╗██║ ██╔╝██╔══██╗
26-
██║ ██║███████║███████║██╔████╔██║███████║█████╔╝ ███████║
27-
██║ ██║██╔══██║██╔══██║██║╚██╔╝██║██╔══██║██╔═██╗ ██╔══██║
28-
██████╔╝██║ ██║██║ ██║██║ ╚═╝ ██║██║ ██║██║ ██╗██║ ██║
29-
╚═════╝ ╚═╝ ╚═╝╚═╝ ╚═╝╚═╝ ╚═╝╚═╝ ╚═╝╚═╝ ╚═╝╚═╝ ╚═╝
30-
d h a m a k a . d e v
3124

32-
the local AI capability layer for web apps
33-
on-device · zero latency · zero cost · every browser · offline
34-
```
25+
[![npm](https://img.shields.io/npm/v/dhamaka.svg?logo=npm)](https://www.npmjs.com/package/dhamaka) &nbsp;·&nbsp; [![license](https://img.shields.io/npm/l/dhamaka.svg)](./LICENSE) &nbsp;·&nbsp; [live demos →](https://protosphinx.github.io/dhamaka/)
3526

3627
</div>
3728

@@ -327,6 +318,25 @@ In browsers, the factory prefers `window.ai` when available and falls back to th
327318

328319
## ✦ five-minute quickstart
329320

321+
### just want to use the SDK?
322+
323+
```bash
324+
npm install dhamaka
325+
```
326+
327+
```js
328+
import { SmartField } from "dhamaka";
329+
330+
new SmartField(document.querySelector("#city"), {
331+
task: "city-to-state",
332+
onResult: (r) => console.log(r.fields), // { state, country, tz, currency, ... }
333+
});
334+
```
335+
336+
The package is self-contained — the WASM runtime is bundled, no extra install step. See **[the API](#-the-api)** below for the full surface.
337+
338+
### want to hack on the runtime itself?
339+
330340
```bash
331341
git clone https://github.com/protosphinx/dhamaka
332342
cd dhamaka

packages/playground/public/index.html

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,23 @@ <h2>Formula editor <small style="color:#8a8a99;font-weight:400">(erp.ai-style)</
6868
</a>
6969
</section>
7070

71+
<section class="notes">
72+
<h3>Install</h3>
73+
<pre class="diagram">npm install dhamaka</pre>
74+
<p>
75+
The package ships with the WASM runtime bundled — one install,
76+
nothing else to configure. Available on
77+
<a href="https://www.npmjs.com/package/dhamaka">npm</a> and
78+
<a href="https://github.com/protosphinx/dhamaka/packages">GitHub Packages</a>.
79+
</p>
80+
<pre class="diagram">import { SmartField } from "dhamaka";
81+
82+
new SmartField(document.querySelector("#city"), {
83+
task: "city-to-state",
84+
onResult: (r) =&gt; console.log(r.fields),
85+
});</pre>
86+
</section>
87+
7188
<section class="notes">
7289
<h3>The architecture</h3>
7390
<pre class="diagram">

0 commit comments

Comments
 (0)