From 9c25b04de5cda62432ad2110576158cd3a1b0f67 Mon Sep 17 00:00:00 2001 From: William Grosset Date: Fri, 12 Jan 2024 17:21:53 -0700 Subject: [PATCH] Prepare package for release --- README.md | 18 +++++++++--------- package.json | 23 +++++++++++++++++++++-- 2 files changed, 30 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 2d9b04d..118e795 100644 --- a/README.md +++ b/README.md @@ -61,15 +61,15 @@ function App() { ### Props -| Prop | Type | Default | Description | -| ------------- | --------------------- | -------------- | ------------------------------------------------------------- | -| `startDate` | `Date` | **required** | Start date | -| `values` | `Array` | **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` | **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 index ce21961..a956146 100644 --- 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",