Skip to content
Browse files

Slowly getting the docs in place.

  • Loading branch information...
1 parent 621a95e commit 8dcfcaa6261f167fa910472930cc0a9a03860b64 @notahat committed
Showing with 5 additions and 3 deletions.
  1. +5 −3 README.markdown
View
8 README.markdown
@@ -5,7 +5,7 @@
Machinist 2 is **still in beta**!
If you're using Rails 3, you'll want to give Machinist 2 a go, but be aware
-that the documentation is still lacking.
+that the documentation is still patchy.
That said, have a look at [the
specs](https://github.com/notahat/machinist/tree/master/spec), starting with
@@ -20,7 +20,7 @@ release version of Machinist, [then go with Machinist
- [Home page](http://github.com/notahat/machinist)
- [Google group](http://groups.google.com/group/machinist-users), for support
-- [Bug tracker](http://github.com/notahat/machinist/issues), for Machinist bugs
+- [Bug tracker](http://github.com/notahat/machinist/issues), for reporting Machinist bugs
## Introduction
@@ -221,7 +221,7 @@ And `Post.make` will construct a new Post.
I've tested this with:
Ruby versions: 1.8.7, 1.9.2
-Rails versions: 2.3, 3.0, 3.1
+Rails versions: 2.3, 3.0
It may well be happy with other versions too, but I'm not promising anything.
Compatibility patches are welcome.
@@ -232,6 +232,8 @@ Compatibility patches are welcome.
The Machinist specs and source code were written to be read, and I'm pretty
happy with them. Don't be have a look under the hood.
+If you want to submit a patch:
+
- Fork the project.
- Make your feature addition or bug fix.
- Add tests for it. This is important so I don't break it in a

0 comments on commit 8dcfcaa

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