diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..23a07fb --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,9 @@ +The MIT License (MIT) + +Copyright (c) <2017> + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index 45d6de1..6e7f37b 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ or $ ./node_modules/.bin/bower install ``` -in case you don't have [bower](TBD) installed globally. +in case you don't have [bower](https://bower.io/) installed globally. Finally, simply start the service @@ -30,7 +30,7 @@ and modify the component. The browser will be reloaded dynamically as you modify ## How it works -The project simply make use of [browser-sync](TBD). +The project simply make use of [browser-sync](https://browsersync.io/). The actual command line used is the following: @@ -40,7 +40,10 @@ $ browser-sync start --server app -f app --serveStatic bower_components --no-not * The command expects your code / project to be sitting in the `app` folder. Change as desired * `bower_components` files will be served synamically, which means you don't need to reference the `bower_components folder when using external dependencies`. - + +Your browser should open a new tab by itself once browser sync is running. Otherwise, navigate to [http://localhost:3000](http://localhost:3000). + +Also, think about checking out [http://localhost:3001/](http://localhost:3001/) for the browsersync overview. ## Author