papergraph 1.0.0 → 1.0.2

package/README.md

@@ -1,9 +1,30 @@
 # 📄 PaperGraph
 
+[![npm version](https://img.shields.io/npm/v/papergraph?color=cb3837&logo=npm&logoColor=white)](https://www.npmjs.com/package/papergraph)
+[![Node.js](https://img.shields.io/badge/node-%3E%3D20-339933?logo=node.js&logoColor=white)](https://nodejs.org/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.7-3178C6?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
+
 **Build interactive research-paper connectivity graphs from any topic.**
 
 PaperGraph is a command-line tool that discovers academic papers, traces their citation networks, computes text similarity, runs graph algorithms, and produces explorable visualizations — all from a single command.
 
+### 📦 Install
+
+```bash
+npm install -g papergraph
+```
+
+Then run:
+
+```bash
+papergraph build -t "transformer attention" -o graph.db
+papergraph view -i graph.db -o graph.html
+open graph.html
+```
+
+> **No API keys required** — works out of the box with [OpenAlex](https://openalex.org/) (free, open academic data).
+
 ---
 
 ## ✨ Motivation
@@ -208,19 +229,25 @@ Paper-Graph/
 
 ## 🚀 Quick Start
 
+### Global Install (recommended)
+
 ```bash
-# Install dependencies
-npm install
+npm install -g papergraph
+papergraph build -t "neural speech enhancement" -d 2 -m 100 -o graph.db
+papergraph view -i graph.db -o graph.html
+```
 
-# Build
-npm run build
+### From Source
 
-# Run
-npx papergraph build -t "transformer attention" -o graph.db
-npx papergraph view -i graph.db
+```bash
+git clone https://github.com/DashankaNadeeshanDeSilva/Paper-Graph.git
+cd Paper-Graph
+npm install
+npm run build
+node dist/index.js build -t "transformer attention" -o graph.db
 ```
 
-See [USAGE.md](./USAGE.md) for detailed usage instructions.
+See **[USAGE.md](./USAGE.md)** for full CLI reference, configuration options, and workflow examples.
 
 ---
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "papergraph",
-    "version": "1.0.0",
+    "version": "1.0.2",
     "description": "CLI tool that creates research-paper connectivity graphs from topics, keywords, or paper titles. Produces SQLite DB + self-contained HTML visualization.",
     "type": "module",
     "main": "dist/index.js",
@@ -60,4 +60,4 @@
         "typescript": "^5.7.3",
         "vitest": "^3.0.5"
     }
-}
+}