README.md 1.1 KB

{%= title || name %}

{%= description %}

Use {%= name %} library in your project

DELETE THIS PARAGRAPH, IF {%= name %} IS A LIBRARY. DELETE WHOLE THIS SECTION IF {%= name %} IS AN APP, NOT A LIBRARY.

If not already done, install Amber and create an Amber project with amber init, as shown in Amber Instructions.

In a project, run

npm install {%= name %} --save
grunt devel
amber serve

Go to http://localhost:4000/ in your browser and in all packages that use {%= name %}, add '{%= namespace %}/{%= name %}' to the package imports, save the change and commit the package. Reload.

Contributing

  1. Have amber cli tooling installed. If you don't, see first box in these instructions.

  2. Fork and/or clone the project, then bring it alive by: npm run init.

  3. Developing the project: Start server with amber serve and go to http://localhost:4000/ in your browser. Overlay with buttons to open IDE should appear shortly.