Preparing for first release

marcojakob · marcojakob · commit e1a44b70827e · 2013-06-05T04:11:19.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,5 @@
 Changelog
 ================
 
-## Version 0.0.1 (2013-05-??) ##
+## Version 0.0.1 (2013-06-05) ##
 * Initial Version.
diff --git a/README.md b/README.md
@@ -1,59 +1,62 @@
 HTML5 Drag and Drop for Dart
 ================
 
-Library to streamline **Native HTML5 Drag and Drop** in Dart.
+Helper library to simplify **Native HTML5 Drag and Drop** in Dart.
 
 ## Features ##
-* Sortable
-* Same functionality and API for IE9+, Firefox, Chrome, ?Safari? (not tested yet), 
-  ?Opera? (not tested yet)
+* Make any HTML Element `Draggable`.
+* Create `Dropzone`s and connect them with `Draggable`s.
+* Sortable (similar to jQuery UI Sortable).
+* Uses fast native HTML5 Drag and Drop of the browser.
+* Same functionality and API for IE9+, Firefox, Chrome. (Safari and Opera have 
+  not been tested yet, let me know if it works). 
 
 ## Demo ##
-TODO: demo page...
-Examples are available in the `example` directory.
+See [HTML5 Drag and Drop in action](http://edu.makery.ch/projects/dart-html5-drag-and-drop/) (with code examples).
 
-## Usage ##
+All examples are also available in the `example` directory on GitHub.
+
+## Installation ##
 
 ### 1. Add Dependency ###
 Add the folowing to your **pubspec.yaml** and run **pub install**
 ```yaml
 	dependencies:
-	  html5_drag_and_drop: any
+	  html5_dnd: any
 ```
 
-### 2. ... ###
-```dart
-import 'package:html5_drag_and_drop/drag_and_drop.dart';
-
-// ...
+### 2. Add Polyfill JavaScript ###
+To make HTML5 Drag and Drop work in Internet Explorer include the following 
+JavaScript file inside the `<head>` of your application's HTML like so:
+```html
+<script type="text/javascript" src="packages/html5_dnd/dnd.polyfill.js"></script>
 ```
 
-## License ##
-The MIT License (MIT)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+### 3. Import ###
+Import the `html5_dnd` library in your Dart code. If your using the Sortable 
+functionality, also 
+add `html5_sortable`.
 
+```dart
+import 'package:html5_dnd/html5_dnd.dart';
+import 'package:html5_dnd/html5_sortable.dart';
 
+// ...
+```
 
+### 4. Use it ###
+See the demo page above or the `example` directory to see how to use it. There 
+are also plenty of Dart Doc comments in the code for some additional details.
 
 
+## Thanks and Contributions ##
+I'd like to thank the people who kindly helped me with their answers or put 
+some tutorial or code examples online. They've already contributed to this 
+project.
 
+If you'd like to contribute too, you're welcome to file issues or 
+[fork](https://help.github.com/articles/fork-a-repo) my repository on GitHub.
 
 
+## License ##
+The MIT License (MIT)
diff --git a/example/html5_dnd_example.css b/example/html5_dnd_example.css
@@ -26,12 +26,15 @@ h1, h2 {
   font-weight: normal;
   margin-top: 60px;
   margin-bottom: 20px;
-  clear: both;
 }
 
 /* --------------------------------------------------------------------------
  * General styles
  * ------------------------------------------------------------------------*/
+h2 {
+  clear: both; 
+}
+ 
 .example-container {
   width: 306px;
   padding: 0;
@@ -137,7 +140,7 @@ h1, h2 {
   margin-bottom: 80px;
 }
 
-.example-code .content div {
+.example-code .content > div {
   display: none;
   color: #93a1a1;
 }
diff --git a/example/html5_dnd_example.dart b/example/html5_dnd_example.dart
@@ -11,7 +11,7 @@ import 'package:html5_dnd/html5_sortable.dart';
 part 'codeblocks.dart';
 
 main() {
-  // Default PrintHandler prints output to console.
+  // Uncomment to enable logging.
 //  Logger.root.onRecord.listen(new PrintHandler().call);
 //  Logger.root.level = Level.FINEST;
   
@@ -151,6 +151,7 @@ sectionNestedElements() {
   TextAreaElement textarea = query('#nested-elements .dropzone textarea');
   InputElement input = query('#nested-elements .dropzone input');
   input.value = 'Drag here!';
+  textarea.text = '';
   
   new Draggable(dragme);
   
diff --git a/example/html5_dnd_example.html b/example/html5_dnd_example.html
@@ -7,7 +7,7 @@
   
   <link rel="stylesheet" href="html5_dnd_example.css">
   
-  <!-- Script to make HTML5 drag and drop work in IE9 on elements other links and images -->
+  <!-- Script to make HTML5 drag and drop work in IE -->
   <script type="text/javascript" src="packages/html5_dnd/dnd.polyfill.js"></script>
 </head>
 <body>
@@ -38,8 +38,12 @@ <h1>Dart HTML5 Drag and Drop</h1>
       </p>
       <p>
         For <strong>installation instructions, download and source code</strong> 
-        see <a href="https://github.com/marcojakob/dart-html5-dnd">Dart HTML5 
-        Drag and Drop</a> on GitHub.
+        see 
+        <ul>
+          <li>
+            <a href="https://github.com/marcojakob/dart-html5-dnd">Dart HTML5 Drag and Drop</a> on GitHub.
+          </li>
+        </ul>
       </p>
     </div>
     
@@ -236,9 +240,9 @@ <h2>Connected Sortable Lists</h2>
         <li class="other">Item 6</li>
       </ul>
     </div>
-    
-    <script type="application/dart" src="html5_dnd_example.dart"></script>
-    <script src="packages/browser/dart.js"></script>
   </article>
+  
+  <script type="application/dart" src="html5_dnd_example.dart"></script>
+  <script src="packages/browser/dart.js"></script>
 </body>
 </html>
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,12 +1,13 @@
 name: html5_dnd
-version: 0.0.1
+version: 0.1.0
 author: Marco Jakob <majakob@gmx.ch>
 description: HTML5 Drag and Drop
 homepage: https://github.com/marcojakob/dart-html5-dnd
+documentation: http://edu.makery.ch/projects/dart-html5-drag-and-drop/
 dependencies:
   js: any
-  meta: any
   logging: any
+  meta: any
 dev_dependencies:
   browser: any
   logging_handlers: any
