Initial README.md

Still missing "How to Use" and "Description".

README.md

@@ -1 +1,106 @@
-# Revolutionary
+<h1 align="center">
+  <br>
+  Revolutionary
+  <br>
+  <img src="https://raw.githubusercontent.com/matuella/Revolutionary/master/Resources/icon.png" alt="Revolutionary Icon" width="300">
+  <br>
+</h1>
+
+<h4 align="center">Create your circular/progress/timer/stopwatch/countdown animations with ease!</h4>
+
+<p align="center">
+  <a href="https://travis-ci.org/matuella/Revolutionary">
+    <img src="https://travis-ci.org/matuella/Revolutionary.svg?branch=master)">
+  </a>
+  <a href="http://cocoadocs.org/docsets/Revolutionary">
+    <img src="https://img.shields.io/badge/docs-API-lightgrey.svg">
+  </a>
+  <a href="https://github.com/matuella/Revolutionary/blob/master/LICENSE">
+    <img src="https://img.shields.io/github/license/matuella/Revolutionary.svg">
+  </a>
+  <a href="https://github.com/matuella/Revolutionary/releases">
+    <img src="https://img.shields.io/github/release/matuella/Revolutionary.svg">
+  </a>
+  <a href="https://docs.swift.org/swift-book/">
+    <img src="https://img.shields.io/badge/swift%20version-4.2-red.svg">
+  </a>
+  <a href="https://github.com/Carthage/Carthage">
+    <img src="https://img.shields.io/badge/carthage-compatible-4BC51D.svg?style=flat">
+  </a>
+  <a href="http://cocoapods.org/pods/Revolutionary">
+    <img src="https://img.shields.io/cocoapods/p/Revolutionary.svg">
+  </a>
+</p>
+<p align="center">
+  <a href="https://saythanks.io/to/matuella">
+    <img src="https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg" alt="Say Thanks!">
+  </a>
+  <a href="http://makeapullrequest.com">
+    <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=shields">
+  </a>
+</p>
+
+<p align="center">
+  <a href="#features-and-roadmap">Features and Roadmap</a> |
+  <a href="#installing">Installing</a> |
+  <a href="#how-to-use">How To Use</a> |
+  <a href="#contributing">Contributing</a> |
+  <a href="#changelog">Changelog</a> |
+  <a href="#license">License</a>
+</p>
+
+## Description
+
+### TODO
+
+## Features and Roadmap
+
+Features **implemented/planned** for 2019 (in order of priority):
+
+- [x] Framework for iOS
+- [x] Examples for iOS
+- [x] Support Carthage
+- [x] Support CocoaPods
+- [x] Add TravisCI
+- [ ] Repository description + how to use
+- [ ] Implement Textures on the `SKNode`s
+- [ ] Add Swiftlint
+- [ ] Add Jazzy Docs
+- [ ] Support watchOS
+- [ ] Examples for watchOS
+- [ ] Expose more properties to ease the customization of the `Revolutionary.swift` + improve the iOS examples with it
+- [ ] Find a better way to replicate the commentaries on the Builder (not just copy pasting the docs from `Revolutionary.swift`)
+- [ ] Add Tests (+ support with some check tool, like Coveralls)
+- [ ] Support/Examples/Showcases for watchOS
+- [ ] Support/Examples/Showcases for macOS
+- [ ] Support/Examples/Showcases for tvOS
+
+## Installing
+
+- **Carthage**: add `github "matuella/Revolutionary" ~> 0.3.0` to your `Cartfile`;
+- **CocoaPods**: add `pod 'Revolutionary'` to your `Podfile`;
+- **Manual**: copy all the files in the [Revolutionary][revolutionary_folder] folder to your project and you're good to go.
+
+## How to Use
+
+### TODO
+
+## Contributing
+
+If you have any suggestion, issue or idea, please contribute with what you've in your mind. Also, read [CONTRIBUTING][contributing].
+
+## Changelog
+
+The version history and meaningful changes will all be available in the [CHANGELOG][changelog].
+
+## License 
+
+Revolutionary is licensed under MIT - [LICENSE][license].
+
+
+<!--- Links --->
+
+[changelog]:https://github.com/matuella/Revolutionary/blob/master/CHANGELOG.md
+[contributing]:https://github.com/matuella/Revolutionary/blob/master/CONTRIBUTING.md
+[license]:https://github.com/matuella/Revolutionary/blob/master/LICENSE
+[revolutionary_folder]:https://github.com/matuella/Revolutionary/tree/master/Revolutionary