Added some documentation

Author: michaelbromley

README.md

@@ -0,0 +1,20 @@
+# Angular Utilities
+
+I am working on a large-scale AngularJS-based project and I'll be extracting
+any useful re-usable components that I make and putting them here.
+
+I'm following the convention of the [Ng-Boilerplate] (https://github.com/ngbp/ngbp) project of bundling
+all relevant code together, so that you should be able to simply copy the
+directory of the component you want to use, and it will include unit tests
+and any other dependencies.
+
+This code is made available under the MIT license, so feel free to use any of these is your projects. If you find any of them useful I'd be happy to get feedback!
+
+## Index of Utilities
+
+Filters
+-------
+
+- **ordinalDate** : Works like the built-in date filter, but will add the English ordinal suffix to the day.
+
+That's all for now. Watch this space - there'll be more soon I expect.

license.txt

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2014 Michael Bromley
+
+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.

package.json

@@ -1,11 +1,8 @@
 {
   "name": "angularUtils",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "description": "A collection of re-usable AngularJS components",
   "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
   "author": "Michael Bromley",
   "license": "MIT",
   "devDependencies": {

src/filters/ordinalDate/README.md

@@ -0,0 +1,16 @@
+# Ordinal Date Filter
+
+This is a wrapper filter around the built-in [Angular date filter](http://docs.angularjs.org/api/ng.filter:date),
+which adds the facility to display the English ordinal date suffix to the 'day' part of the format string.
+
+## Example
+
+Given the timestamp 1384474920000 (15th November 2013, 00:22:00), and the date format string 'd MM yyyy',
+the regular Angular date filter will return '15 November 2013'. This filter will return '15th November 2013'. Simple.
+
+## Usage
+
+Include the filter definition somewhere in your Angular app and then use it like any filter:
+
+    {{ 1384474920000 | ordinalDate }}
+