Skip to content

Commit 221c495

Browse files
committed
README: npm/repo links, install from npm vs source; .gitignore .npmrc; package.json repository url
Made-with: Cursor
1 parent 930a331 commit 221c495

3 files changed

Lines changed: 13 additions & 1 deletion

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ node_modules/
22
dist/
33
*.log
44
.env
5+
.npmrc
56
.sysmledgraph/
67
.sysmledgraph-*/
78
.sysmledgraph-index-result.txt

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
Path-only SysML indexer: builds a knowledge graph from `.sysml` files and exposes it via **MCP** (for Cursor AI) and **CLI**. The LSP used for indexing lives in **`lsp/`** and is used only by this repo.
44

5+
- **npm:** [sysmledgraph](https://www.npmjs.com/package/sysmledgraph)`npm install sysmledgraph`
6+
- **Repo:** [github.com/chouswei/codebase-sysmledgraph](https://github.com/chouswei/codebase-sysmledgraph)
7+
58
## Requirements
69

710
- **Node.js 20+**
@@ -10,7 +13,15 @@ Path-only SysML indexer: builds a knowledge graph from `.sysml` files and expose
1013

1114
## Install
1215

16+
**From npm (use as CLI/MCP):**
17+
```bash
18+
npm install sysmledgraph
19+
cd node_modules/sysmledgraph && npm run setup-lsp
20+
```
21+
22+
**From source (develop or run from repo):**
1323
```bash
24+
git clone https://github.com/chouswei/codebase-sysmledgraph.git && cd codebase-sysmledgraph
1425
npm install
1526
npm run build
1627
npm run setup-lsp

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
"license": "MIT",
3535
"repository": {
3636
"type": "git",
37-
"url": "https://github.com/chouswei/codebase-sysmledgraph"
37+
"url": "git+https://github.com/chouswei/codebase-sysmledgraph.git"
3838
},
3939
"files": [
4040
"dist",

0 commit comments

Comments
 (0)