Skip to content

Commit

Permalink
docs(all): add readme.md and update license.
Browse files Browse the repository at this point in the history
  • Loading branch information
Carlos Mantilla committed Jul 5, 2015
1 parent e4e8f7b commit 74b2f85
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 1 deletion.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
Copyright (c) Carlos Mantilla <cmantilla@aliongroo.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
Expand Down
29 changes: 29 additions & 0 deletions README.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
#Angular Weather

Component to add weather information to your project

##How do I add angular-weather to my project?

- Install the module `bower install angular-weather --save`

- Add the library to your project

```html
<script type="text/javascript" src="bower_components/angular-weather/angular-weather.js"></script>
```

- Declare the module in your application

```javascript
angular.module('myApp', ['angular-weather']);
```

- User the directive to display the current weather in somewhere

```html
<angular-weather city="Houston"></angular-weather>
```

##License

angular-weather is licensed under the MIT license. See the [LICENSE](LICENSE) file for more details.

0 comments on commit 74b2f85

Please sign in to comment.