@cyguin/changelog-core 0.1.6 → 0.1.7

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.
Files changed (2) hide show
  1. package/README.md +17 -0
  2. package/package.json +5 -2
package/README.md ADDED
@@ -0,0 +1,17 @@
1
+ # @cyguin/changelog-core
2
+
3
+ TypeScript types and the `ChangelogAdapter` interface for `@cyguin/changelog`.
4
+
5
+ ## what it is
6
+
7
+ Every other `@cyguin/changelog-*` package depends on this. It ships the shared `ChangelogEntry` type and the `ChangelogAdapter` interface that both storage adapters implement.
8
+
9
+ ## do you need this directly?
10
+
11
+ Probably not — it's a dependency of the adapter and CLI packages. Install it only if you're building a custom adapter.
12
+
13
+ ## links
14
+
15
+ [Full changelog monorepo →](https://github.com/cyguin/changelog)
16
+
17
+ [Full docs →](https://github.com/cyguin/changelog#readme)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cyguin/changelog-core",
3
- "version": "0.1.6",
3
+ "version": "0.1.7",
4
4
  "type": "module",
5
5
  "description": "TypeScript types and ChangelogAdapter interface for @cyguin/changelog",
6
6
  "keywords": ["changelog", "changelog-feed", "nextjs", "typescript"],
@@ -11,13 +11,16 @@
11
11
  "url": "https://github.com/cyguin/changelog"
12
12
  },
13
13
  "homepage": "https://github.com/cyguin/changelog#readme",
14
+ "bugs": {
15
+ "url": "https://github.com/cyguin/changelog/issues"
16
+ },
14
17
  "main": "./dist/index.js",
15
18
  "module": "./dist/index.js",
16
19
  "types": "./dist/index.d.ts",
17
20
  "exports": {
18
21
  ".": "./dist/index.js"
19
22
  },
20
- "files": ["dist"],
23
+ "files": ["dist", "README.md"],
21
24
  "scripts": {
22
25
  "build": "tsup",
23
26
  "test": "vitest run",