M README.md → README.md

@@ -2,6 +2,12 @@ # kitten
 
 a meowing, typesafe interaction router for discord.js
 
+[https://npmx.dev/package/@purrkit/core]
+
+```sh
+npm install @purrkit/core
+```
+
 see [GET-STARTED.md](./GET-STARTED.md) for a quick introduction to using kitten
 
 here is a quick hello world example

A pkgs/core/README.md

@@ -0,0 +1,51 @@
+# kitten
+
+a meowing, typesafe interaction router for discord.js
+
+[https://npmx.dev/package/@purrkit/core]
+
+```sh
+npm install @purrkit/core
+```
+
+see [GET-STARTED.md](./GET-STARTED.md) for a quick introduction to using kitten
+
+here is a quick hello world example
+
+```ts
+import { Client } from "discord.js";
+import { Kitten } from "@purrkit/core";
+
+const client = new Client({ intents: [] });
+const kitten = new Kitten(client);
+
+const helloWorldCommand = kitten.command("hello-world", {
+	description: "replies with hello world",
+	run: (interaction) => {
+		interaction.reply("Hello World!");
+	},
+});
+
+client.once("clientReady", async () => {
+	kitten.register({
+		commands: [helloWorldCommand],
+	});
+
+	await kitten.sync();
+	console.log("ready!!!");
+});
+
+client.login(process.env.DISCORD_TOKEN);
+```
+
+## copying
+
+this project is licensed under the european union public license (eupl) v1.2.
+you can find the full license text either [here][LISC] or on the official
+[eupl website][EU], which also contains translations of the license in various
+languages.
+
+<!-- links -->
+
+[LISC]: ./LICENSE
+[EU]: https://interoperable-europe.ec.europa.eu/collection/eupl/eupl-text-eupl-12

M pkgs/core/package.json → pkgs/core/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@purrkit/core",
-	"version": "1.0.2",
+	"version": "1.0.3",
 	"license": "EUPL-1.2",
 	"author": {
 		"name": "apr",
@@ -30,5 +30,6 @@ },
 	"peerDependencies": {
 		"discord.js": "^14.26.4",
 		"typescript": "^5"
-	}
+	},
+	"readme": "./README.md"
 }