Added documentation

README.md

@@ -1,3 +1,7 @@
+[![](https://dcbadge.vercel.app/api/server/fTpqUTMmVa?style=flat)](https://discord.gg/fTpqUTMmVa) [<img src="https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white" height="20px" />](https://www.linkedin.com/in/oskardudycz/) [![Github Sponsors](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&link=https://github.com/sponsors/oskardudycz/)](https://github.com/sponsors/oskardudycz/) [![blog](https://img.shields.io/badge/blog-event--driven.io-brightgreen)](https://event-driven.io/?utm_source=event_sourcing_nodejs) [![blog](https://img.shields.io/badge/%F0%9F%9A%80-Architecture%20Weekly-important)](https://www.architecture-weekly.com/?utm_source=event_sourcing_nodejs)
+
+![](./src/docs/public/social.png)
+
 # Pongo
 
 Pongo - MongoDB on Postgres with all strong consistency benefits
@@ -35,8 +39,8 @@ const cruella = { _id: uuid(), name: "Cruella", age: 40 };
 await pongoCollection.insertOne(roger);
 await pongoCollection.insertOne(cruella);
 
-let inserted = await pongoCollection.insertOne(alice);
-const anitaId = inserted.insertedId;
+const { insertedId } = await pongoCollection.insertOne(alice);
+const anitaId = insertedId;
 
 // Updating
 await users.updateOne({ _id: anitaId }, { $set: { age: 31 } });
@@ -74,8 +78,8 @@ const cruella = { _id: uuid(), name: "Cruella", age: 40 };
 await pongoCollection.insertOne(roger);
 await pongoCollection.insertOne(cruella);
 
-let inserted = await pongoCollection.insertOne(alice);
-const anitaId = inserted.insertedId;
+const { insertedId } = await pongoCollection.insertOne(alice);
+const anitaId = insertedId;
 
 // Updating
 await users.updateOne({ _id: anitaId }, { $set: { age: 31 } });

src/docs/.vitepress/config.mts

@@ -23,10 +23,7 @@ export default defineConfig({
     sidebar: [
       {
         text: 'Documentation',
-        items: [
-          { text: 'Getting Started', link: '/getting-started' },
-          { text: 'API Docs', link: '/api-docs' },
-        ],
+        items: [{ text: 'Getting Started', link: '/getting-started' }],
       },
     ],
 

src/docs/getting-started.md

@@ -2,4 +2,94 @@
 
 ![](/logo.png)
 
-TODO
+Pongo is a MongoDB on Postgres with all strong consistency benefits.
+
+Install Pongo as an npm module and save it to your package.json
+
+```bash
+npm install @event-driven-io/pongo
+```
+
+## Example
+
+You can use Pongo syntax with explicit typing about supported syntax:
+
+```ts
+import { pongoClient } from '@event-driven-io/pongo';
+import { v4 as uuid } from 'uuid';
+
+type User = { name: string; age: number };
+
+const connectionString =
+  'postgresql://dbuser:[email protected]:3211/mydb';
+
+const pongoClient = pongoClient(postgresConnectionString);
+const pongoDb = pongoClient.db();
+
+const users = pongoDb.collection<User>('users');
+const roger = { name: 'Roger', age: 30 };
+const anita = { name: 'Anita', age: 25 };
+const cruella = { _id: uuid(), name: 'Cruella', age: 40 };
+
+// Inserting
+await pongoCollection.insertOne(roger);
+await pongoCollection.insertOne(cruella);
+
+let inserted = await pongoCollection.insertOne(alice);
+const anitaId = inserted.insertedId;
+
+// Updating
+await users.updateOne({ _id: anitaId }, { $set: { age: 31 } });
+
+// Deleting
+await pongoCollection.deleteOne({ _id: cruella._id });
+
+// Finding by Id
+const anitaFromDb = await pongoCollection.findOne({ _id: anitaId });
+
+// Finding more
+const users = await pongoCollection.find({ age: { $lt: 40 } });
+```
+
+Or use MongoDB compliant shim:
+
+```ts
+import { MongoClient } from '@event-driven-io/pongo';
+import { v4 as uuid } from 'uuid';
+
+type User = { name: string; age: number };
+
+const connectionString =
+  'postgresql://dbuser:[email protected]:3211/mydb';
+
+const pongoClient = new MongoClient(postgresConnectionString);
+const pongoDb = pongoClient.db();
+
+const users = pongoDb.collection<User>('users');
+const roger = { name: 'Roger', age: 30 };
+const anita = { name: 'Anita', age: 25 };
+const cruella = { _id: uuid(), name: 'Cruella', age: 40 };
+
+// Inserting
+await pongoCollection.insertOne(roger);
+await pongoCollection.insertOne(cruella);
+
+let inserted = await pongoCollection.insertOne(alice);
+const anitaId = inserted.insertedId;
+
+// Updating
+await users.updateOne({ _id: anitaId }, { $set: { age: 31 } });
+
+// Deleting
+await pongoCollection.deleteOne({ _id: cruella._id });
+
+// Finding by Id
+const anitaFromDb = await pongoCollection.findOne({ _id: anitaId });
+
+// Finding more
+const users = await pongoCollection.find({ age: { $lt: 40 } }).toArray();
+```
+
+## Is it production ready?
+
+What's there it's safe to use, but it's far from being 100% compliant with MongoDB.

src/docs/index.md

@@ -4,27 +4,24 @@ layout: home
 
 hero:
   name: 'Pongo'
-  text: 'Event Sourcing development made simple'
-  tagline: Take your event-driven applications back to the future!
+  text: 'Like Mongo<br/>But on Postgres<br/>And<br/>Strong Consistency'
+  tagline: 'Flexibility or Consistency? Why not both!'
   image:
     src: /logo.png
     alt: Pongo logo
   actions:
     - theme: brand
       text: Getting Started
       link: /getting-started
-    - theme: alt
-      text: API Docs
-      link: /api-docs
     - theme: alt
       text: 🧑‍💻 Join Discord Server
       link: https://discord.gg/fTpqUTMmVa
 
 features:
+  - title: Keep your data consistent
+    details: Don't be afraid of getting inconsistent state
   - title: DevExperience as prime goal
     details: Reduce the boilerplate, and focus on delivery with accessible tooling
-  - title: Gain insights from your data
-    details: Unleash the power of your data with Event Sourcing capabilities
-  - title: All patterns in one place
-    details: Use Decider, Workflow and other event-driven best practices seamlessly
+  - title: Known experience, new capabilities
+    details: Keep your muscle memory, but get new tricks and TypeScript superpowers
 ---