From 67257c1ed6faccfd47dea7f2e61584bd58e40af4 Mon Sep 17 00:00:00 2001 From: Todd Beauchamp Date: Thu, 12 Jan 2017 11:28:21 -0500 Subject: [PATCH] feat(sandbox): update readme with dev instructions --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index febdf84b1..e58df4edb 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ ## Table of Contents - [Installation](#installation) - [Usage](#usage) +- [Development](#development) - [License](#license) ## Installation @@ -67,6 +68,21 @@ Once the **Carousel** and **Slide** components are installed globally or importe ``` +## Development + +A sandboxed dev environment is provided by [vue-play](https://github.com/vue-play/vue-play). Changes made to the component files will appear in real time in the sandbox. + +To begin development, run: + +``` bash +npm install +npm run dev +``` + +then navigate to `http://localhost:5000` + +To modify and add sandbox scenarios, edit `play/index.js` + ## License This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.