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

Basic examples in README.md #89

Open
benjaminapetersen opened this issue Jul 27, 2015 · 4 comments
Open

Basic examples in README.md #89

benjaminapetersen opened this issue Jul 27, 2015 · 4 comments

Comments

@benjaminapetersen
Copy link

Greetings!

This repo looks interesting. I'd love to see some basic usage snippets (examples) in the README explaining how you use each element (directive, service, etc). It looks like there are some handy components here, but I'm not entirely sure what they are all for.

@andreareginato
Copy link
Collaborator

@benjaminapetersen,

I don't know If I got your answer right. We actually focused quite a lot of our time on creating the oauth-ng documentation. It's not in the Readme, but in the documentation pointed out from the Readme. If you need more things to know, let us know and we'll do our best.

@benjaminapetersen
Copy link
Author

Saw the link. Its def nice and minimal. Initially when I read it I get the impression its just a directive. Later in the document I see that there is AccessToken, which caused me to go searching the source code and find Profile, etc. The README might be a handy place to simply list each component with some minimal usage.

Nothing huge, just an enhancement suggestion to help surface that you provide more than initially expected.

@andreareginato
Copy link
Collaborator

Hi @benjaminapetersen, thanks a lot for your suggestion. I think would be really nice to have these addition. Right now I'm focused on other projects, but I would love to ask you if you want to add this little section, to help new users using the directive.

@benjaminapetersen
Copy link
Author

Cool, I'll see what I can do.

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