chore: add readme

Author: rnons

.github/workflows/publish.yaml

@@ -65,7 +65,7 @@ jobs:
           echo "### No version cut" >> $GITHUB_STEP_SUMMARY
           echo "Check Semantic Release output for details"
       - name: Clean Github Release for RC
-        if: ${{ contains(steps.semantic.outputs.new_release_version, '-rc.') == false }}
+        if: ${{ steps.semantic.outputs.new_release_version != '' && contains(steps.semantic.outputs.new_release_version, '-rc.') == false }}
         run:  ./scripts/clean-rc-releases.sh
         env:
           GH_TOKEN: ${{ secrets.ACCESS_TOKEN }}

README.md

@@ -1 +1,25 @@
-# api
+# Sentio API
+
+## Setup
+
+```
+pnpm add @sentio/api
+```
+
+## Usage
+
+```ts
+import { Configuration, WebApi } from "@sentio/api";
+
+
+const config = new Configuration({
+  apiKey: process.env.SENTIO_API_KEY,
+});
+const api = new WebApi(config);
+const projects = await api.getProjectList();
+console.log(projects);
+```
+
+## Documentation
+
+[Sentio API Reference](https://docs.sentio.xyz/reference)

test/simple.test.ts

@@ -7,7 +7,7 @@ test("getProjectList", async () => {
   assert(apiKey, "API key can't be found for the test");
 
   const config = new Configuration({
-    apiKey: apiKey,
+    apiKey,
   });
   const api = new WebApi(config);
   const projects = await api.getProjectList();