@nkootstra/block-kit 0.0.1 → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Niels Kootstra
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,51 @@
-# @nkootstra/block-kit
+# Block Kit for React
 
-Placeholder release. Install 0.1.0 or later: https://block-kit.kootstra.io
+`@nkootstra/block-kit` renders Slack [Block Kit](https://docs.slack.dev/block-kit/) JSON in React, pixel-for-pixel the way Slack does. Pass it the `blocks` your app sends to `chat.postMessage` or `views.open` and it draws the message, modal or Home tab, with working buttons, menus, date pickers and inputs.
+
+Documentation: **<https://block-kit.kootstra.io>**
+
+## Install
+
+The package needs React 19 or later.
+
+```sh
+bun add @nkootstra/block-kit @fontsource/lato @fontsource/roboto-mono
+```
+
+Import the stylesheet and fonts once, near the root of your app, then render a message:
+
+```tsx
+import "@nkootstra/block-kit/styles.css";
+import "@fontsource/lato/400.css";
+import "@fontsource/lato/700.css";
+import { BlockKitProvider, Message } from "@nkootstra/block-kit";
+
+export function App() {
+  return (
+    <BlockKitProvider>
+      <Message
+        blocks={[
+          { type: "section", text: { type: "mrkdwn", text: "*Hello* from Block Kit :wave:" } },
+        ]}
+      />
+    </BlockKitProvider>
+  );
+}
+```
+
+The [installation guide](https://block-kit.kootstra.io/installation) lists the remaining font weights and the entry points, and the [quickstart](https://block-kit.kootstra.io/quickstart) wires up an interactive approval message.
+
+## Entry points
+
+| Import                            | What it contains                                                  |
+| --------------------------------- | ----------------------------------------------------------------- |
+| `@nkootstra/block-kit`            | Components, the provider, hooks and payload builders              |
+| `@nkootstra/block-kit/styles.css` | The stylesheet                                                    |
+| `@nkootstra/block-kit/mrkdwn`     | The mrkdwn parser, without React                                  |
+| `@nkootstra/block-kit/transport`  | Sends interactions to your app's request URL from the browser     |
+| `@nkootstra/block-kit/server`     | Signs and relays interactions to your app from your server        |
+| `@nkootstra/block-kit/web-api`    | User, channel and usergroup resolvers backed by the Slack Web API |
+
+## License
+
+[MIT](./LICENSE)