Skip to content

Commit 042bdd4

Browse files
committed
docs: update links + install
1 parent c389e56 commit 042bdd4

File tree

1 file changed

+33
-5
lines changed

1 file changed

+33
-5
lines changed

README.md

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -487,22 +487,44 @@ items:
487487
488488
### Installation
489489
490-
🚧……🚧
490+
```sh
491+
pnpm i @jsfe/core
492+
```
493+
494+
```ts
495+
import '@jsfe/core';
496+
```
497+
498+
```ts
499+
import '@shoelace-style/shoelace/dist/themes/light.css';
500+
import '@shoelace-style/shoelace/dist/themes/dark.css';
501+
```
491502

492503
### Implementation
493504

494505
> **Note**
495506
> As the project is fresh, API is subject to changes
496507
508+
You can try the [multi-frameworks examples](https://github.com/json-schema-form-element/examples) like this:
509+
510+
```
511+
npx degit https://github.com/json-schema-form-element/examples jsfe-examples
512+
513+
cd jsfe-examples
514+
515+
npm i
516+
npm run dev
517+
```
518+
497519
#### Vanilla JS / Astro (SSR)
498520

499-
See [examples/src/components/VanillaJs.ts](https://github.com/json-schema-form-element/blob/examples/src/components/VanillaJs.astro)
521+
See [examples/src/components/VanillaJs.ts](https://github.com/json-schema-form-element/examples/blob/main/src/components/VanillaJs.astro)
500522

501523
TypeScript inference: YES for client side, not for SSR (Astro JSX-y template).
502524

503525
#### Lit
504526

505-
See [examples/src/components/LitJs.ts](https://github.com/json-schema-form-element/blob/examples/src/components/LitJs.ts)
527+
See [examples/src/components/LitJs.ts](https://github.com/json-schema-form-element/examples/blob/main/src/components/LitJs.ts)
506528

507529
TypeScript inference: YES.
508530

@@ -568,13 +590,13 @@ class MyApp extends LitElement {
568590

569591
#### Solid
570592

571-
See [examples/src/components/SolidJs.tsx](https://github.com/json-schema-form-element/blob/examples/src/components/SolidJs.tsx)
593+
See [examples/src/components/SolidJs.tsx](https://github.com/json-schema-form-element/examples/blob/main/src/components/SolidJs.tsx)
572594

573595
TypeScript inference: YES.
574596

575597
#### Vue
576598

577-
See [examples/src/components/VueJs.vue](https://github.com/json-schema-form-element/blob/examples/src/components/VueJs.vue)
599+
See [examples/src/components/VueJs.vue](https://github.com/json-schema-form-element/examples/blob/main/src/components/VueJs.vue)
578600

579601
TypeScript inference: NO.
580602

@@ -676,3 +698,9 @@ the ideas RSJF creators brought.
676698
- [vuetify-jsonschema-form](https://koumoul-dev.github.io/vuetify-jsonschema-form/latest)
677699
- [jsonforms](https://jsonforms.io)
678700
- [remoteoss/json-schema-form](https://github.com/rjsf-team/react-jsonschema-form)
701+
702+
**See also**:
703+
704+
- [remark-lint-frontmatter-schema](https://github.com/JulianCataldo/remark-lint-frontmatter-schema): Validate your Markdown **frontmatter** data against a **JSON schema**.
705+
- [retext-case-police](https://github.com/JulianCataldo/retext-case-police): Check popular names casing. Example: ⚠️ `github` → ✅ `GitHub`.
706+
- [astro-openapi](https://github.com/JulianCataldo/astro-openapi): An Astro toolset for building full-stack operations easily, with type-safety and documentation as first-class citizens.

0 commit comments

Comments
 (0)