svg-heatmap 4.0.0 → 4.0.2

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 +10 -1
  2. package/package.json +3 -6
package/README.md CHANGED
@@ -1,12 +1,15 @@
1
1
  # svg-heatmap
2
+
2
3
  Generate GitHub-style SVG heatmaps
3
4
 
4
5
  ## Install
6
+
5
7
  ```
6
- yarn add svg-heatmap
8
+ pnpm add svg-heatmap
7
9
  ```
8
10
 
9
11
  ## Usage
12
+
10
13
  ```javascript
11
14
  import { generate, PalettePresets } from "svg-heatmap";
12
15
 
@@ -20,15 +23,21 @@ for (let i = 0; i < 365; i++) {
20
23
 
21
24
  const svg = generate(data, 2019, PalettePresets.gitHub);
22
25
  ```
26
+
23
27
  ## Palette Presets
28
+
24
29
  ### GitHub (`gitHub`)
30
+
25
31
  ![Example](./examples/github.svg)
26
32
 
27
33
  ### GitHub Old (`gitHubOld`)
34
+
28
35
  ![Example](./examples/github-old.svg)
29
36
 
30
37
  ### Blue (`blue`)
38
+
31
39
  ![Example](./examples/blue.svg)
32
40
 
33
41
  ### Auto Generated Palette
42
+
34
43
  ![Example](./examples/auto.svg)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "svg-heatmap",
3
- "version": "4.0.0",
3
+ "version": "4.0.2",
4
4
  "description": "Generate GitHub-like heatmap graphs with SVG",
5
5
  "main": "lib/index.js",
6
6
  "type": "module",
@@ -14,14 +14,11 @@
14
14
  ],
15
15
  "repository": {
16
16
  "type": "git",
17
- "url": "git+https://github.com/jayden-chan/svg-heatmap.git"
17
+ "url": "https://git.sr.ht/~jayden-chan/svg-heatmap"
18
18
  },
19
19
  "author": "Jayden Chan <jaydencn7@gmail.com>",
20
20
  "license": "GPL-3.0-only",
21
- "bugs": {
22
- "url": "https://github.com/jayden-chan/svg-heatmap/issues"
23
- },
24
- "homepage": "https://github.com/jayden-chan/svg-heatmap#readme",
21
+ "homepage": "https://git.sr.ht/~jayden-chan/svg-heatmap",
25
22
  "devDependencies": {
26
23
  "@types/node": "^20.19.41",
27
24
  "typescript": "^6.0.3"