Skip to content

Commit cedf6d1

Browse files
committed
Updated Readme.
1 parent b3b8433 commit cedf6d1

File tree

1 file changed

+34
-2
lines changed

1 file changed

+34
-2
lines changed

README.md

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

333
## Packages
434

535
* live-elements-core
636
* live-elements-loader
737
* live-elements-web
38+
* live-elements-web-cli
839
* live-elements-web-server
40+
* live-testspec
941
* live-web
1042
* live-web-view
11-
* live-web-edit
43+
* live-web-edit

0 commit comments

Comments
 (0)