@hyva-commerce/about 1.0.1 → 1.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 +22 -9
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,9 +1,9 @@
1
1
  # Hyvä Themes
2
2
 
3
- This npm scope belongs to **[Hyvä Themes](https://www.hyva.io)**.
3
+ This package name is held by **[Hyvä Themes](https://www.hyva.io)**.
4
4
 
5
- This package is an intentionally empty placeholder. It contains no code, has no
6
- dependencies and runs no install scripts. It only exists to show who owns this scope.
5
+ It is an intentionally empty placeholder. It contains no code, has no dependencies and
6
+ runs no install scripts.
7
7
 
8
8
  ## Looking for Hyvä packages on npm?
9
9
 
@@ -11,12 +11,24 @@ Hyvä publishes its npm packages under the
11
11
  [`@hyva-themes`](https://www.npmjs.com/org/hyva-themes) scope, for example
12
12
  [`@hyva-themes/hyva-modules`](https://www.npmjs.com/package/@hyva-themes/hyva-modules).
13
13
 
14
- Hyvä Themes reserves the `@hyva`, `@hyvaio` and `@hyva-commerce` scopes to protect
15
- the Hyvä community against name squatting and dependency confusion. Packages in these
16
- scopes are placeholders and contain no Hyvä software.
14
+ If you installed this package by accident, check the package name for a missing
15
+ `@hyva-themes/` prefix or a typo, and check your registry configuration.
17
16
 
18
- If a build tried to install a package from one of these scopes, check for a typo in
19
- the package name or a misconfigured registry.
17
+ ## Why Hyvä Themes holds this name
18
+
19
+ Anyone who drops the `@hyva-themes/` prefix in `npm install`, or copies a broken snippet
20
+ from documentation or a blog post, gets whatever is published under the shorter name.
21
+ Whoever controlled these names could ship code to Hyvä users that way. Hyvä Themes holds
22
+ them so that such a mistake installs this empty package instead:
23
+
24
+ | Names | Match |
25
+ |------------------------------------|-----------------------------------------|
26
+ | `@hyva`, `@hyvaio` | the Hyvä brand and the hyva.io domain |
27
+ | `@hyva-commerce`, `hyva-commerce` | Hyvä Commerce |
28
+ | `@hyva-checkout`, `hyva-checkout` | Hyvä Checkout |
29
+ | `@hyva-modules`, `hyva-modules` | the `@hyva-themes/hyva-modules` package |
30
+
31
+ Packages under these names are placeholders and contain no Hyvä software.
20
32
 
21
33
  ## About Hyvä
22
34
 
@@ -27,9 +39,10 @@ Our products include Hyvä Theme, Hyvä Checkout, Hyvä UI, Hyvä Commerce and H
27
39
  - Documentation: [docs.hyva.io](https://docs.hyva.io)
28
40
  - GitHub: [github.com/hyva-themes](https://github.com/hyva-themes)
29
41
 
30
- ## Security
42
+ ## Contact
31
43
 
32
44
  Please report security issues to [security@hyva.io](mailto:security@hyva.io).
45
+ For questions about these package names, contact [info@hyva.io](mailto:info@hyva.io).
33
46
 
34
47
  ## License
35
48
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@hyva-commerce/about",
3
- "version": "1.0.1",
4
- "description": "Placeholder package of Hyvä Themes. It contains no code. Visit https://www.hyva.io",
3
+ "version": "1.0.2",
4
+ "description": "Placeholder held by Hyvä Themes to protect Hyvä users from typosquatting. Hyvä's npm packages are under @hyva-themes. Contains no code.",
5
5
  "keywords": [
6
6
  "hyva",
7
7
  "hyva-themes",