publish to npm

.npmignore

@@ -0,0 +1,4 @@
+/docs
+/wasm
+/examples
+/llama.cpp

LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Xuan Son NGUYEN
+
+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.

README.md

@@ -9,14 +9,15 @@ Wasm allow llama.cpp to run directly on browser, without any server part.
 ## Features
 
 - Typescript support
+- No runtime dependency (see [package.json](./package.json))
 - High-level API: completions, embeddings
 - Low-level API: (de)tokenize, KV cache control, sampling control,...
 - Ability to load splitted model
 - Auto switch between single-thread and multi-thread build based on browser support
 
 ## Demo and documentations
 
-**Documentation:** https://ngxson.github.io/docs/
+**Documentation:** https://ngxson.github.io/wllama/docs/
 
 Demo:
 - Basic usages with completions and embeddings: https://ngxson.github.io/wllama/examples/basic/
@@ -63,7 +64,6 @@ npm run build
 
 ## TODO
 
-- Deploy to npm
 - Guide: How to split gguf file?
 - Support multi-sequences: knowing the resource limitation when using WASM, I don't think having multi-sequences is a good idea
 - Multi-modal: Waiting for refactoring LLaVA implementation from llama.cpp

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "wllama",
-  "version": "1.0.0",
+  "name": "@wllama/wllama",
+  "version": "1.0.1",
   "description": "Low-level WASM binding for llama.cpp",
   "main": "index.js",
   "type": "module",