@changelogai/core 0.1.0 → 0.1.2
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.
- package/README.md +24 -3
- package/package.json +13 -8
package/README.md
CHANGED
|
@@ -2,6 +2,27 @@
|
|
|
2
2
|
|
|
3
3
|
Framework-agnostic SDK for fetching changelogs from ChangelogAI.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
5
|
+
### Install the package
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @changelogai/core
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
### Add your API key
|
|
12
|
+
|
|
13
|
+
Create or update your `.env` file with your API key:
|
|
14
|
+
|
|
15
|
+
```bash title=".env"
|
|
16
|
+
CHANGELOG_AI_API_SECRET=clai_*******
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
You can generate an API key from the **Settings** page in your Changelog AI dashboard under the **API Keys** section.
|
|
20
|
+
|
|
21
|
+
### Fetch your changelogs
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import { fetchChangelogs } from "@changelogai/core";
|
|
25
|
+
|
|
26
|
+
const logs = await fetchChangelogs();
|
|
27
|
+
console.log(logs);
|
|
28
|
+
```
|
package/package.json
CHANGED
|
@@ -1,24 +1,29 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@changelogai/core",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "Framework-agnostic core SDK for ChangelogAI",
|
|
5
|
-
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"repository": {
|
|
7
|
+
"type": "git",
|
|
8
|
+
"url": "https://github.com/NikolaV96/changelogai-core"
|
|
9
|
+
},
|
|
10
|
+
"homepage": "https://changelogai.dev",
|
|
11
|
+
"bugs": {
|
|
12
|
+
"url": "https://github.com/NikolaV96/changelogai-core/issues"
|
|
13
|
+
},
|
|
6
14
|
"type": "module",
|
|
7
|
-
|
|
8
15
|
"main": "dist/index.js",
|
|
9
16
|
"module": "dist/index.js",
|
|
10
17
|
"types": "dist/index.d.ts",
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
18
|
+
"files": [
|
|
19
|
+
"dist"
|
|
20
|
+
],
|
|
14
21
|
"engines": {
|
|
15
22
|
"node": ">=18"
|
|
16
23
|
},
|
|
17
|
-
|
|
18
24
|
"scripts": {
|
|
19
25
|
"build": "tsup"
|
|
20
26
|
},
|
|
21
|
-
|
|
22
27
|
"devDependencies": {
|
|
23
28
|
"@types/node": "^25.0.3",
|
|
24
29
|
"tsup": "^8.5.1",
|