Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve readme #90

Open
brianc opened this issue Jun 5, 2013 · 3 comments
Open

improve readme #90

brianc opened this issue Jun 5, 2013 · 3 comments

Comments

@brianc
Copy link
Owner

brianc commented Jun 5, 2013

Just a todo note for myself. I think the readme examples could be cleaned up a bit. It's sort of a piece of marketing material and as such could be designed to give new-comers a better intro into how and why to use this library.

@diwu1989
Copy link
Collaborator

I think instead of brushing up the Readme markdown file, we can just spend some time to build a github page that show how to use this. Similar to the github page for http://hiddentao.github.io/squel/

@diwu1989
Copy link
Collaborator

Also, the upcoming change to make all nodes immutable is significant enough that it may make sense to brush up the readme and github page after the major API changes.

@brianc
Copy link
Owner Author

brianc commented Jun 11, 2013

I agree with everything you just said. As per usual. haha! 👍

On Tue, Jun 11, 2013 at 4:30 PM, diwu1989 [email protected] wrote:

Also, the upcoming change to make all nodes immutable is significant
enough that it may make sense to brush up the readme and github page after
the major API changes.


Reply to this email directly or view it on GitHubhttps://github.com//issues/90#issuecomment-19293710
.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants