chore: update README for puter.js to publish on npm

2026-05-02 13:09:39 -05:00 · 2025-09-19 02:34:33 -07:00
parent 654dfa9124
commit 493334b030
2 changed files with 97 additions and 40 deletions
@@ -1,21 +1,72 @@
-<h3 align="center">Puter.js</h3>
-<h4 align="center">The official JavaScript SDK for Puter.com. Cloud and AI features right from your frontend code!</h4>
-<p align="center">
-    <a href="https://docs.puter.com/playground/"><strong>« LIVE DEMO »</strong></a>
-    <br />
-    <br />
-    <a href="https://docs.puter.com" target="_blank">Docs</a>
-    ·
-    <a href="https://puter.com">Puter.com</a>
-    ·
-    <a href="https://discord.com/invite/PQcx7Teh8u">Discord</a>
-    ·
-    <a href="https://reddit.com/r/puter">Reddit</a>
-    ·
-    <a href="https://twitter.com/HeyPuter">X (Twitter)</a>
-</p>
+# Puter.js
+
+The official JavaScript SDK for [Puter.com](https://puter.com) — access cloud and AI features directly from your frontend code.
+
+---
+
+## Installation (npm)
+
+```sh
+npm install @heyputer/puterjs
+```
+
+### Importing
+
+#### ES Modules
+
+```js
+import puter from '@heyputer/puterjs';
+```
+
+#### CommonJS
+
+```js
+const puter = require('@heyputer/puterjs');
+```
+
+## Usage Example
+
+```js
+// Print a message
+puter.print('Hello from Puter.js!');
+
+// Chat with GPT-3.5 Turbo
+puter.ai.chat('What color was Napoleon\'s white horse?').then(response => {
+  puter.print(response);
+});
+```
+
+---
+
+## CDN Usage
+
+Include Puter.js directly in your HTML via CDN:
+
+```html
+<script src="https://js.puter.com/v2/"></script>
+<script>
+  puter.print('Hello from Puter.js via CDN!');
+  puter.ai.chat('What color was Napoleon\'s white horse?').then(response => {
+    puter.print(response);
+  });
+</script>
+```
+
+---
+
+## Documentation & Community
+
+- [Docs](https://docs.puter.com)
+- [Live Demo](https://docs.puter.com/playground/)
+- [Puter.com](https://puter.com)
+- [Discord](https://discord.com/invite/PQcx7Teh8u)
+- [Reddit](https://reddit.com/r/puter)
+- [X (Twitter)](https://twitter.com/HeyPuter)
+
+---
+
+## Local Development Example

-### Example
 Make sure the development server is running.

 ```html
@@ -33,4 +84,3 @@ Make sure the development server is running.
    </script>
 </body>
 </html>
-```
@@ -1,23 +1,30 @@
 {
-  "name": "@heyputer/puterjs",
-  "version": "1.0.0",
-  "description": "",
-  "main": "index.js",
-  "type": "module",
-  "scripts": {
-    "start-server": "npx http-server --cors -c-1",
-    "start-webpack": "webpack && webpack --output-filename puter.dev.js --watch --devtool source-map",
-    "start": "concurrently \"npm run start-server\" \"npm run start-webpack\"",
-    "build": "webpack && { echo \"// Copyright 2024-present Puter Technologies Inc. All rights reserved.\"; echo \"// Generated on $(date '+%Y-%m-%d %H:%M')\n\"; cat ./dist/puter.js; } > temp && mv temp ./dist/puter.js"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "Apache-2.0",
-  "devDependencies": {
-    "concurrently": "^8.2.2",
-    "webpack-cli": "^5.1.4"
-  },
-  "dependencies": {
-    "@heyputer/kv.js": "^0.1.92"
-  }
-}
+    "name": "@heyputer/puterjs",
+    "version": "1.0.0",
+    "description": "Puter.js - A JavaScript library for interacting with Puter services.",
+    "main": "index.js",
+    "type": "module",
+    "publishConfig": {
+        "registry": "https://registry.npmjs.org/"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/HeyPuter/puter.git"
+    },
+    "scripts": {
+        "start-server": "npx http-server --cors -c-1",
+        "start-webpack": "webpack && webpack --output-filename puter.dev.js --watch --devtool source-map",
+        "start": "concurrently \"npm run start-server\" \"npm run start-webpack\"",
+        "build": "webpack && { echo \"// Copyright 2024-present Puter Technologies Inc. All rights reserved.\"; echo \"// Generated on $(date '+%Y-%m-%d %H:%M')\n\"; cat ./dist/puter.js; } > temp && mv temp ./dist/puter.js"
+    },
+    "keywords": [],
+    "author": "Puter Technologies Inc.",
+    "license": "Apache-2.0",
+    "devDependencies": {
+        "concurrently": "^8.2.2",
+        "webpack-cli": "^5.1.4"
+    },
+    "dependencies": {
+        "@heyputer/kv.js": "^0.1.92"
+    }
+}