fix: README links

synthql · Apr 17, 2024 · 473dba2 · 473dba2
1 parent 2036ed2
commit 473dba2
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 6 deletions.
diff --git a/packages/backend/README.md b/packages/backend/README.md
@@ -20,7 +20,7 @@ queryEngine.execute(query);
 
 ## Links
 
--   [Website](https://synthql.github.io/synthql/)
--   [Docs](https://synthql.github.io/synthql/docs/getting-started)
+-   [Website](https://synthql.github.io/SynthQL/)
+-   [Docs](https://synthql.github.io/SynthQL/docs/getting-started)
 -   [X/Twitter](https://twitter.com/fernandohur)
 -   [Github](https://github.com/synthql/synthql)
diff --git a/packages/cli/README.md b/packages/cli/README.md
@@ -0,0 +1,26 @@
+# @synthql/backend
+
+The SynthQL backend.
+
+```ts
+import { QueryEngine } from "@synthql/backend"
+
+// Initialize the client
+const queryEngine = new QueryEngine({...})
+
+// Write your query
+const query = from('users')
+    .columns('id','first_name')
+    .where({id: {in:[1,2,3]}})
+    .many()
+
+// Execute the query
+queryEngine.execute(query);
+```
+
+## Links
+
+-   [Website](https://synthql.github.io/SynthQL/)
+-   [Docs](https://synthql.github.io/SynthQL/docs/getting-started)
+-   [X/Twitter](https://twitter.com/fernandohur)
+-   [Github](https://github.com/synthql/synthql)
diff --git a/packages/queries/README.md b/packages/queries/README.md
@@ -10,7 +10,7 @@ const query = from('users').columns('id', 'first_name').where({ id: 1 }).many();
 
 ## Links
 
--   [Website](https:/synthqlr.github.io/synthql/)
--   [Docs](https://synthql.github.io/synthql/docs/getting-started)
+-   [Website](https:/synthqlr.github.io/SynthQL/)
+-   [Docs](https://synthql.github.io/SynthQL/docs/getting-started)
 -   [X/Twitter](https://twitter.com/fernandohur)
 -   [Github](https://github.com/synthql/synthql)
diff --git a/packages/react/README.md b/packages/react/README.md
@@ -12,7 +12,7 @@ useSynthql(query);
 
 ## Links
 
--   [Website](https://synthql.github.io/synthql/)
--   [Docs](https://synthql.github.io/synthql/docs/getting-started)
+-   [Website](https://synthql.github.io/SynthQL/)
+-   [Docs](https://synthql.github.io/SynthQL/docs/getting-started)
 -   [X/Twitter](https://twitter.com/fernandohur)
 -   [Github](https://github.com/synthql/synthql)