search

geddy / model

Datastore-agnostic ORM in JavaScript
265 stars 55 forks source link

proofread, format, and improve clarity in README #194

Closed benatkin closed 10 years ago

benatkin commented 10 years ago

I went through the README to learn more about model and while I was going through it I had ideas on how to make it more straightforward or consistent. I'm not done yet. I wanted to show you what I have, and I have a question: It appears most of this is duplicated in geddy. Where should it be updated first?

mde commented 10 years ago

Wow, this is great. :) Basically, when we do a Geddy release, we copy-paste the markdown from here to there. It's not ideal, but we don't have a good way of doing multi-repo sync yet. Let me take a look at what you've got here, and I'll chime in with some feedback.

mde commented 10 years ago

This looks really good. The only feedback I have initially is it would be great to have the code examples conform to our styleguide: https://github.com/geddy/js-styleguide Kinda nitpicky, but good to have consistency.

Once we merge this, we can transfer it all over to the Geddy docs as well, although it doesn't seem super urgent, and we could certainly just wait until the next Geddy release for this.

benatkin commented 10 years ago

@mde thanks! Nah, it's not nitpicky. I added a commit which corrects the code that I noticed that doesn't conform to the style guide.

mde commented 10 years ago

Perfect, thanks!

benatkin commented 10 years ago

Oops, I forgot to update the TOC. Are you using a tool to generate it or just updating it manually?