Skip to content

Commit ec40084

Browse files
committed
Update README.md
1 parent b3b8433 commit ec40084

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,45 @@
1-
# Live Elements Web packages
1+
# Live Elements Web [NPM Version](https://img.shields.io/npm/v/live-elements-web?color=%23624aa6)
2+
3+
Packages for Live Elements Web
4+
5+
* **Website**: [liveelements.io](https://liveelements.io)
6+
* **Documentation**: [livekeys.io/docs](https://liveelements.io/documentation)
7+
8+
## Getting Started
9+
10+
The guide at [liveelements.io](https://liveelements.io/documentation/quick-start-language) will take you through the
11+
language and how to use it to create web applications.
12+
13+
## Install and Setup
14+
15+
`lvweb` is a tool in `live-elements-web-cli` package that helps you setup a project with live elements:
16+
17+
```sh
18+
npm i live-elements-web-cli # install lvweb
19+
npx lvweb init . # use lvweb to generate a starting project
20+
npx lvweb serve # serve the created project
21+
```
22+
23+
## Try it out
24+
25+
There's a live playground available at [play.liveelements.io](https://play.liveelements.io).
26+
27+
You can also setup one locally using `lvweb`:
28+
29+
```sh
30+
npm i live-elements-web-cli # install lvweb
31+
npx lvweb init --template playground . # generate a playground project
32+
npx lvweb serve # serve playground
33+
```
234

335
## Packages
436

537
* live-elements-core
638
* live-elements-loader
739
* live-elements-web
40+
* live-elements-web-cli
841
* live-elements-web-server
42+
* live-testspec
943
* live-web
1044
* live-web-view
1145
* live-web-edit

0 commit comments

Comments
 (0)