Update readme with additional info

This commit is contained in:
nlighteneddesign
2020-01-11 04:54:03 +00:00
parent c07b07ae31
commit 99da84b7c9
+9 -4
View File
@@ -51,9 +51,10 @@ Clone this repository
### Step 2 ### Step 2
Install necessary modules Install necessary modules (verified to work in node 8.x)
`yarn install` or `npm install` `yarn install` or `npm install`
### Step 3 ### Step 3
Do a test lint & build on the project. You can see available scripts in the package.json Do a test lint & build on the project. You can see available scripts in the package.json
@@ -70,11 +71,15 @@ Customize to suit your needs and contribute it back to the community
## Starting a new card from boilerplate-card with [devcontainer][devcontainer] ## Starting a new card from boilerplate-card with [devcontainer][devcontainer]
Note: this is available only in vscode ensure you have the [Remote Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension installed.
1. Fork and clone the repository. 1. Fork and clone the repository.
2. Open the [devcontainer][devcontainer] and run `npm start` when it's ready. 2. Install necessary modules (verified to work in node 8.x)
3. The compiled `.js` file will be accessible on `yarn install` or `npm install`
3. Open a [devcontainer][devcontainer] terminal and run `npm start` when it's ready.
4. The compiled `.js` file will be accessible on
`http://127.0.0.1:5000/boilerplate-card.js`. `http://127.0.0.1:5000/boilerplate-card.js`.
4. On a running Home Assistant installation add this to your Lovelace 5. On a running Home Assistant installation add this to your Lovelace
`resources:` `resources:`
```yaml ```yaml