@rline/schema 1.0.0 → 1.0.1

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 +29 -3
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,17 +1,43 @@
1
1
  # @rline/schema
2
2
 
3
- - [ ] add description for the library
3
+ - Commonly used schemas
4
4
 
5
5
  ## Installation
6
6
 
7
+ You do not need to install the package to use schemas
8
+
7
9
  ```shell
8
10
  pnpm add @rline/schema
9
11
  ```
10
12
 
11
13
  ## Usage
12
14
 
13
- - [ ] add example for the librarys
15
+ JSON
16
+
17
+ ```json
18
+ {
19
+ "$schema": "https://raw.githubusercontent.com/rbrightline/common/refs/heads/main/libs/schema/schema-config.schema.json"
20
+ }
21
+ ```
22
+
23
+ YAML
24
+
25
+ ```yaml
26
+ # yaml-language-server: $schema=https://raw.githubusercontent.com/rbrightline/common/refs/heads/main/libs/schema/schema-config.schema.json
27
+ ```
28
+
29
+ ## Local Usage
30
+
31
+ JSON
32
+
33
+ ```json
34
+ {
35
+ "$schema": "./node_modules/@rline/schema/schema-config.schema.json"
36
+ }
37
+ ```
14
38
 
15
- ```typescript
39
+ YAML
16
40
 
41
+ ```yaml
42
+ # yaml-language-server: $schema=./node_modules/@rline/schema/schema-config.schema.json
17
43
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rline/schema",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "Project description",
5
5
  "author": {
6
6
  "email": "robert.brightline@gmail.com",