diff options
Diffstat (limited to 'packages/sdk')
| -rw-r--r-- | packages/sdk/README.md | 16 | ||||
| -rw-r--r-- | packages/sdk/package.json | 18 | ||||
| -rw-r--r-- | packages/sdk/tsconfig.json | 2 |
3 files changed, 18 insertions, 18 deletions
diff --git a/packages/sdk/README.md b/packages/sdk/README.md index 5aad1847..1bfc10ac 100644 --- a/packages/sdk/README.md +++ b/packages/sdk/README.md @@ -1,21 +1,21 @@ -# Hoarder SDK +# Karakeep SDK -This package contains the official typescript SDK for the hoarder API. +This package contains the official typescript SDK for the karakeep API. ## Installation ``` -npm install @hoarderapp/sdk +npm install @karakeep/sdk ``` ## Usage ```typescript -import { createHoarderClient } from "@hoarderapp/sdk"; +import { createHoarderClient } from "@karakeep/sdk"; // Create a client const apiKey = "my-super-secret-key"; -const addr = `https://hoarder.mydomain.com`; +const addr = `https://karakeep.mydomain.com`; const client = createHoarderClient({ baseUrl: `${addr}/api/v1/`, headers: { @@ -56,9 +56,9 @@ console.log(searchResponse.status, searchResults, searchError); ## Docs -API docs can be found [here](https://docs.hoarder.app/api). +API docs can be found [here](https://docs.karakeep.app/api). ## Versioning -- This package follows the minor version of the hoarder server. So new APIs introduced in Hoarder version `0.21.0` will be available in this package starting from version `0.21.0`. -- Hoarder strives to maintain backward compatibility in its APIs, so older versions of this package should continue working with newer hoarder server versions. +- This package follows the minor version of the karakeep server. So new APIs introduced in Karakeep version `0.21.0` will be available in this package starting from version `0.21.0`. +- Karakeep strives to maintain backward compatibility in its APIs, so older versions of this package should continue working with newer karakeep server versions. diff --git a/packages/sdk/package.json b/packages/sdk/package.json index 50ffe075..51408f79 100644 --- a/packages/sdk/package.json +++ b/packages/sdk/package.json @@ -1,8 +1,8 @@ { "$schema": "https://json.schemastore.org/package.json", - "name": "@hoarderapp/sdk", - "version": "0.23.0", - "description": "Typescript SDK for Hoarder", + "name": "@karakeep/sdk", + "version": "0.23.2", + "description": "Typescript SDK for Karakeep", "license": "GNU Affero General Public License version 3", "keywords": [ "hoarder", @@ -17,9 +17,9 @@ "types": "./dist/index.d.ts" }, "devDependencies": { - "@hoarder/eslint-config": "workspace:^0.2.0", - "@hoarder/prettier-config": "workspace:^0.1.0", - "@hoarder/tsconfig": "workspace:^0.1.0", + "@karakeep/eslint-config": "workspace:^0.2.0", + "@karakeep/prettier-config": "workspace:^0.1.0", + "@karakeep/tsconfig": "workspace:^0.1.0", "@tsconfig/node22": "^22.0.0", "tsx": "^4.7.1", "vite": "^5.1.0", @@ -36,19 +36,19 @@ }, "repository": { "type": "git", - "url": "git+https://github.com/hoarder-app/hoarder.git", + "url": "git+https://github.com/karakeep-app/karakeep.git", "directory": "packages/sdk" }, "eslintConfig": { "root": true, "extends": [ - "@hoarder/eslint-config/base" + "@karakeep/eslint-config/base" ], "ignorePatterns": [ "src/hoarder-api.d.ts" ] }, - "prettier": "@hoarder/prettier-config", + "prettier": "@karakeep/prettier-config", "dependencies": { "openapi-fetch": "^0.13.3" } diff --git a/packages/sdk/tsconfig.json b/packages/sdk/tsconfig.json index bf344404..07b074a3 100644 --- a/packages/sdk/tsconfig.json +++ b/packages/sdk/tsconfig.json @@ -1,6 +1,6 @@ { "$schema": "https://json.schemastore.org/tsconfig", - "extends": "@hoarder/tsconfig/node.json", + "extends": "@karakeep/tsconfig/node.json", "include": ["src", "vite.config.mts"], "exclude": ["node_modules", "dist"], "compilerOptions": { |
