Prepare package for release

react-sandbox · Jan 13, 2024 · 9c25b04 · 9c25b04
1 parent 1b6eab4
commit 9c25b04
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -61,15 +61,15 @@ function App() {
 
 ### Props
 
-| Prop          | Type                  | Default        | Description                                                   |
-| ------------- | --------------------- | -------------- | ------------------------------------------------------------- |
-| `startDate`   | `Date`                | **required**   | Start date                                                    |
-| `values`      | `Array<Object>`       | **required**   | Array of values containing `date: Date` and `count: number`   |
-| `emptyColor`  | `RGB Tuple`           | `[20, 30, 30]` | Color of a day with a 0 count                                 |
-| `baseColor`   | `RGB Tuple`           | `[0, 128, 0]`  | Color of a day with a 1 or more count                         |
-| `scaleFactor` | `number`              | `10`           | Multiplier to be used against `baseColor` (between 1 and 100) |
-| `className`   | `string`              | `-`            | CSS classes                                                   |
-| `style`       | `React.CSSProperties` | `-`            | CSS styles                                                    |
+| Prop          | Type                  | Default        | Description                                                 |
+| ------------- | --------------------- | -------------- | ----------------------------------------------------------- |
+| `startDate`   | `Date`                | **required**   | Start date                                                  |
+| `values`      | `Array<Object>`       | **required**   | Array of values containing `date: Date` and `count: number` |
+| `emptyColor`  | `RGB Tuple`           | `[20, 30, 30]` | Color of rect with 0 `count`                                |
+| `baseColor`   | `RGB Tuple`           | `[0, 128, 0]`  | Color of rect with 1 or more `count`                        |
+| `scaleFactor` | `number`              | `10`           | Multiplier to be used against `baseColor`                   |
+| `className`   | `string`              | `-`            | CSS classes                                                 |
+| `style`       | `React.CSSProperties` | `-`            | CSS styles                                                  |
 
 ## Development
 

diff --git a/package.json b/package.json
@@ -1,10 +1,29 @@
 {
   "name": "@react-sandbox/heatmap",
-  "version": "1.0.0",
-  "description": "Heatmap component",
+  "version": "0.0.0",
+  "description": "Calendar heatmap component",
   "author": "William Grosset (https://williamgrosset.com)",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/react-sandbox/heatmap.git"
+  },
+  "bugs": {
+    "url": "https://github.com/react-sandbox/heatmap/issues"
+  },
+  "keywords": [
+    "react",
+    "heatmap",
+    "calendar",
+    "svg",
+    "react-heatmap"
+  ],
+  "files": [
+    "dist"
+  ],
   "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
   "scripts": {
     "build": "tsup",
     "dev": "tsup --watch",