Browse Source

Merge pull request #1 from philippeback/master

updated README based on Herby's explanations
Herbert Vojčík 9 years ago
parent
commit
c70d63f7ea
2 changed files with 24 additions and 0 deletions
  1. 24 0
      README.md
  2. BIN
      Screenshot.png

+ 24 - 0
README.md

@@ -1,6 +1,8 @@
 # Amber Smalltalk IDE starter menu
 
 Hidden modal dialog to open Amber IDEs
+This is a library to be used within a project.
+There is an index.html that demonstrates the functionality.
 
 Include as devDependency in your Amber project:
 
@@ -9,3 +11,25 @@ bower install amber-ide-starter-dialog --save-dev
 ```
 
 and include `require(['amber-ide-starter-dialog'], function (s) { s.start(); });` in your index.html.
+
+## How to try
+
+So to just try it, clone it, npm install, bower install, amber config, amber serve and point the browser to http://localhost:4000
+
+## How to install into a project
+
+Include as devDependency in your Amber project:
+
+```
+bower install amber-ide-starter-dialog --save-dev
+```
+
+run ```amber devel``` to regenerate config, include the loading snippet from README into index.html
+
+
+`require(['amber-ide-starter-dialog'], function (s) { s.start(); });` 
+
+and see it open itself after amber loads while in development, and just fail it load while in production. 
+
+![Screenshot](Screenshot.png)
+

BIN
Screenshot.png