@stoplight/elements-core 9.0.22 → 9.0.24

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 +46 -1
  2. package/package.json +2 -1
package/README.md CHANGED
@@ -1 +1,46 @@
1
- # Elements core
1
+ [![docs](https://img.shields.io/badge/API%20Docs-site-green.svg?style=flat-square)](https://meta.stoplight.io/docs/elements)
2
+ [![license](https://img.shields.io/npm/l/@stoplight/elements?style=flat-square)](./LICENSE)
3
+
4
+ # @stoplight/elements-core
5
+
6
+ Shared core components and utilities that power the Stoplight Elements family of API documentation packages.
7
+
8
+ ## Documentation
9
+
10
+ Visit our **[Documentation](https://meta.stoplight.io/docs/elements)** for getting starting, guides and demos.
11
+
12
+ ## About
13
+
14
+ Elements is developed and maintained by [Stoplight][stoplight].
15
+
16
+ ## Anonymized analytics
17
+
18
+ Elements uses [Scarf](https://scarf.sh/) to
19
+ collect [anonymized installation analytics](https://github.com/scarf-sh/scarf-js?tab=readme-ov-file#as-a-user-of-a-package-using-scarf-js-what-information-does-scarf-js-send-about-me).
20
+ These analytics help support the maintainers of this library and ONLY run during installation.
21
+ To [opt out](https://github.com/scarf-sh/scarf-js?tab=readme-ov-file#as-a-user-of-a-package-using-scarf-js-how-can-i-opt-out-of-analytics),
22
+ you can set the `scarfSettings.enabled` field to `false` in your project's `package.json`:
23
+
24
+ ```
25
+ // package.json
26
+ {
27
+ // ...
28
+ "scarfSettings": {
29
+ "enabled": false
30
+ }
31
+ // ...
32
+ }
33
+ ```
34
+
35
+ Alternatively, you can set the environment variable `SCARF_ANALYTICS` to `false` as part of the environment that
36
+ installs your npm packages, e.g., `SCARF_ANALYTICS=false npm install`.
37
+
38
+ ## License
39
+
40
+ Licensed under the Apache 2.0 License, Copyright © 2020-present Stoplight.
41
+
42
+ See [LICENSE](LICENSE) for more information.
43
+
44
+ [stoplight]: https://stoplight.io/?utm_source=github&utm_medium=elements-core&utm_campaign=readme
45
+
46
+ <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=82ad9f18-94ee-4fc6-8b1e-a2e5d1cd5cab&page=README.md" />
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stoplight/elements-core",
3
- "version": "9.0.22",
3
+ "version": "9.0.24",
4
4
  "main": "./index.js",
5
5
  "sideEffects": [
6
6
  "web-components.min.js",
@@ -24,6 +24,7 @@
24
24
  "react-dom": ">=16.8"
25
25
  },
26
26
  "dependencies": {
27
+ "@scarf/scarf": "^1.4.0",
27
28
  "@stoplight/http-spec": "^7.1.0",
28
29
  "@stoplight/json": "^3.21.0",
29
30
  "@stoplight/json-schema-ref-parser": "^9.2.7",