diff options
author | lihaoyi <haoyi.sg@gmail.com> | 2013-11-13 04:14:07 -0800 |
---|---|---|
committer | lihaoyi <haoyi.sg@gmail.com> | 2013-11-13 04:14:07 -0800 |
commit | 12d6290b225dbec02bc04b13d14a2a29132e7da2 (patch) | |
tree | 07aff99746a75fd8b69c2b244dae33a6511a98c5 /readme.md | |
parent | 332e7cde8d103b791e5017b202cd325bcd7d7a1f (diff) | |
download | workbench-12d6290b225dbec02bc04b13d14a2a29132e7da2.tar.gz workbench-12d6290b225dbec02bc04b13d14a2a29132e7da2.tar.bz2 workbench-12d6290b225dbec02bc04b13d14a2a29132e7da2.zip |
added readme, caching to prevent unnecessary work, copy-js-to-target behavior
Diffstat (limited to 'readme.md')
-rw-r--r-- | readme.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..e78c040 --- /dev/null +++ b/readme.md @@ -0,0 +1,33 @@ +scala-js-resource +----------------- + +Provides common functionality when working with [scala-js](https://github.com/lampepfl/scala-js) applications. Enhances the sbt `packageJS` command to: + +- Copies files from your `/src/js` folder directly into the output path +- Bundles up files from your `/src/resource` folder into a single `resource.js` file, and makes them available through the `scala.scalajs.js.Resource` object. For example, calling `Resource("cow.txt").string` will provide you the string contents of `/src/resource/cow.txt`. + +Currently really rough around the edges, but it already does much of what I want it to do. Pull requests welcome! + +License +------- +The MIT License (MIT) + +Copyright (c) 2013 Li Haoyi + +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. |