rumongo 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +32 -1
  2. package/package.json +14 -2
package/README.md CHANGED
@@ -1,5 +1,14 @@
1
1
  # rumongo
2
2
 
3
+ [![npm version](https://img.shields.io/npm/v/rumongo.svg)](https://www.npmjs.com/package/rumongo)
4
+ [![npm downloads](https://img.shields.io/npm/dm/rumongo.svg)](https://www.npmjs.com/package/rumongo)
5
+ [![license](https://img.shields.io/npm/l/rumongo.svg)](LICENSE)
6
+
7
+ > Built by **[Piyush Bhangale](https://github.com/PiyushBhangale)** —
8
+ > 📧 [piyushbhangale1995@gmail.com](mailto:piyushbhangale1995@gmail.com).
9
+ > A Rust-native MongoDB read driver that beats the official Node driver and
10
+ > Mongoose on read throughput and event-loop responsiveness.
11
+
3
12
  **Rust + Mongo.** A Rust-native MongoDB **read** driver for Node.js (napi-rs).
4
13
  Faster reads than the official Node driver and Mongoose by doing BSON parsing in
5
14
  Rust — pipelined fetch, off-thread parallel parse, and optional lazy zero-copy
@@ -250,6 +259,28 @@ node --test __tests__/integration/ # connectivity, pipeline, leak
250
259
  node bench/suite.js # benchmark suite
251
260
  ```
252
261
 
262
+ ## Install (from npm)
263
+
264
+ ```bash
265
+ npm install rumongo
266
+ ```
267
+
268
+ ```js
269
+ const { MongoClient, Model, WorkerPool } = require('rumongo')
270
+ ```
271
+
272
+ ## Author
273
+
274
+ **Piyush Bhangale**
275
+ - GitHub: [@PiyushBhangale](https://github.com/PiyushBhangale)
276
+ - npm: [rumongo](https://www.npmjs.com/package/rumongo)
277
+ - Email: piyushbhangale1995@gmail.com
278
+
279
+ Built rumongo to push MongoDB read performance in Node past the official driver
280
+ and Mongoose using Rust + napi-rs (off-thread BSON parse, lazy field access,
281
+ worker-pool offload). Contributions / issues welcome on
282
+ [GitHub](https://github.com/PiyushBhangale/rumongo/issues).
283
+
253
284
  ## License
254
285
 
255
- MIT
286
+ MIT © [Piyush Bhangale](https://github.com/PiyushBhangale)
package/package.json CHANGED
@@ -1,11 +1,23 @@
1
1
  {
2
2
  "name": "rumongo",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Rust-native MongoDB read driver for Node.js — faster reads than the official driver and Mongoose",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
7
7
  "license": "MIT",
8
- "author": "Piyush Bhangale",
8
+ "author": {
9
+ "name": "Piyush Bhangale",
10
+ "email": "piyushbhangale1995@gmail.com",
11
+ "url": "https://github.com/PiyushBhangale"
12
+ },
13
+ "repository": {
14
+ "type": "git",
15
+ "url": "git+https://github.com/PiyushBhangale/rumongo.git"
16
+ },
17
+ "homepage": "https://github.com/PiyushBhangale/rumongo#readme",
18
+ "bugs": {
19
+ "url": "https://github.com/PiyushBhangale/rumongo/issues"
20
+ },
9
21
  "keywords": [
10
22
  "mongodb",
11
23
  "mongo",