@rline/schema 1.0.0 → 1.0.1

package/README.md

@@ -1,17 +1,43 @@
 # @rline/schema
 
-- [ ] add description for the library
+- Commonly used schemas
 
 ## Installation
 
+You do not need to install the package to use schemas
+
 ```shell
 pnpm add @rline/schema
 ```
 
 ## Usage
 
-- [ ] add example for the librarys
+JSON
+
+```json
+{
+  "$schema": "https://raw.githubusercontent.com/rbrightline/common/refs/heads/main/libs/schema/schema-config.schema.json"
+}
+```
+
+YAML
+
+```yaml
+# yaml-language-server: $schema=https://raw.githubusercontent.com/rbrightline/common/refs/heads/main/libs/schema/schema-config.schema.json
+```
+
+## Local Usage
+
+JSON
+
+```json
+{
+  "$schema": "./node_modules/@rline/schema/schema-config.schema.json"
+}
+```
 
-```typescript
+YAML
 
+```yaml
+# yaml-language-server: $schema=./node_modules/@rline/schema/schema-config.schema.json
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rline/schema",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Project description",
   "author": {
     "email": "robert.brightline@gmail.com",