Skip to content
Browse files

Update README to match other gems' style

  • Loading branch information...
1 parent f9961e8 commit 774a588b451ce4bbd928e626cf97a30bfadc5a95 @dkubb committed Oct 4, 2013
Showing with 8 additions and 13 deletions.
  1. +8 −13 README.md
View
21 README.md
@@ -1,5 +1,7 @@
-abstract_type
-==============
+# abstract_type
+
+This is a small standalone gem featuring a module ripped out from [axiom](https://github.com/dkubb/axiom).
+It allows to declare abstract_type classes and modules in an unobstrusive way.
[![Gem Version](https://badge.fury.io/rb/abstract_type.png)][gem]
[![Build Status](https://secure.travis-ci.org/dkubb/abstract_type.png?branch=master)][travis]
@@ -13,11 +15,7 @@ abstract_type
[codeclimate]: https://codeclimate.com/github/dkubb/abstract_type
[coveralls]: https://coveralls.io/r/dkubb/abstract_type
-This is a small standalone gem featuring a module ripped out from [axiom](https://github.com/dkubb/axiom).
-It allows to declare abstract_type classes and modules in an unobstrusive way.
-
-Examples
---------
+## Examples
``` ruby
class Foo
@@ -41,18 +39,15 @@ object.bar # raises NotImplementedError: Baz#bar is not implemented
```
-Credits
--------
+## Credits
* Dan Kubb ([dkubb](https://github.com/dkubb))
* Markus Schirp ([mbj](https://github.com/mbj))
-Contributing
-------------
+## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
-Copyright
----------
+## Copyright
Copyright © 2009-2013 Dan Kubb. See LICENSE for details.

0 comments on commit 774a588

Please sign in to comment.
Something went wrong with that request. Please try again.