Skip to content

Commit 13282b3

Browse files
committed
docs: Enhance README with development and publishing instructions
- Added a new section on development, detailing the manual publishing process due to npm 2FA requirements. - Included steps for creating a changeset, versioning the package, and publishing to npm. - Documented npm tags associated with the package for better clarity on its functionalities.
1 parent df07d67 commit 13282b3

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,36 @@ The server uses a libSQL database with the following schema:
104104
- Relations table: Stores relationships between entities
105105
- Vector search capabilities implemented using libSQL's built-in vector operations
106106

107+
## Development
108+
109+
### Publishing
110+
111+
Due to npm 2FA requirements, publishing needs to be done manually:
112+
113+
1. Create a changeset (documents your changes):
114+
```bash
115+
pnpm changeset
116+
```
117+
118+
2. Version the package (updates version and CHANGELOG):
119+
```bash
120+
pnpm changeset version
121+
```
122+
123+
3. Publish to npm (will prompt for 2FA code):
124+
```bash
125+
pnpm publish
126+
```
127+
128+
### npm Tags
129+
130+
This package is tagged with:
131+
- `mcp`: Model Context Protocol server
132+
- `memory`: Memory/knowledge management
133+
- `vector`: Vector search capabilities
134+
- `libsql`: SQL database integration
135+
- `knowledge-graph`: Graph-based knowledge storage
136+
107137
## Contributing
108138

109139
Contributions are welcome! Please read our contributing guidelines before submitting pull requests.

0 commit comments

Comments
 (0)