updated license and readme

whoisandy · Jun 7, 2015 · 9abd4c9 · 9abd4c9
1 parent 8cb11e1
commit 9abd4c9
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 16 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Whoisandie
+Copyright (c) 2015 [whoisandie](http://whoisandie.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -1,16 +1,15 @@
-# Yoda
+![Yoda Title](https://s3-us-west-2.amazonaws.com/github.whoisandie.com/yoda-title.png)
 
-Yoda is a simple osx (atleast for now) application which enables you to download videos from youtube.
-Built using [Electron](http://electron.atom.io/) & [React](https://facebook.github.io/react).
+Yoda is a nifty osx application which enables you to browse and download videos from youtube.
+Built using [ReactJS](https://facebook.github.io/react) & [Electron](http://electron.atom.io)
 
-**Note:** Yoda is still in its development phase. Please follow the build instructions to run it.
+![Yoda Screenshot](https://s3-us-west-2.amazonaws.com/github.whoisandie.com/yoda-screen.png)
 
+## Downloads
+The latest version of yoda can be downloaded from the [releases](https://github.com/whoisandie/yoda/releases) page.
+Please note that currently only supports osx.
 
-## Screenshot
-![Yoda Screenshot](https://s3-us-west-2.amazonaws.com/github.whoisandie.com/youdown-screen.png)
-
-
-## Build Instructions
+## Dev Instructions
 Requires gulp to be installed on your machine.
 Clone the repository, install dependencies and run `gulp`
 
@@ -24,13 +23,29 @@ cd yoda && npm install
 gulp
 ```
 
+To build a disk image, run `gulp release`, which will run the necessary tasks
+and create the disk image in a `dist` directory.
+
+## License
 
-## Todo
-+ Update readme first
-+ Install instructions
-+ Dev instructions
+The MIT License (MIT)
 
+Copyright (c) 2015 [whoisandie](http://whoisandie.com)
 
+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:
 
-## License
-Copyright &copy; [Whoisandie](http://whoisandie.com)
+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.