Skip to content
This repository has been archived by the owner on Oct 6, 2018. It is now read-only.

Commit

Permalink
Main README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Chris Pearce committed Apr 25, 2015
1 parent e9794b6 commit b66efcb
Showing 1 changed file with 452 additions and 83 deletions.
Loading

4 comments on commit b66efcb

@chris-pearce
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kllevin thanks for the review, I've done all the updates you suggested: 62e30f3.

@stowball
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've gone through the README with a fine-tooth comb, and correct grammatical errors, improved the readability of sentences, limited the use of "here"-style links, added syntax highlight and more here: https://gist.github.com/stowball/162ca596fbcf1c39dc63

@stowball
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do wonder whether the default stylesheet should be given its own repo though, so it can be versioned as we add/remove featues and be more easily copied

@chris-pearce
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've gone through the README with a fine-tooth comb, and correct grammatical errors, improved the readability of sentences, limited the use of "here"-style links, added syntax highlight and more here: https://gist.github.com/stowball/162ca596fbcf1c39dc63

Thanks @stowball for those updates, it looks good and I can't believe I didn't apply the CSS syntax highlighting 😱. I'll apply those updates to the README tomorrow and by then @kllevin would have looked at the other README's.

I do wonder whether the default stylesheet should be given its own repo though, so it can be versioned as we add/remove featues and be more easily copied

Yeah this has come up a few times, I don't see why not, hopefully the Starter Kit won't be too far away.


The only remaining thing is to finish the Objects README and apply updates to the docs after review. And hopefully merge v2 tomorrow/Tue.

Please sign in to comment.