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

README examples could use some love #36

Open
bdeitte opened this issue Nov 26, 2016 · 4 comments
Open

README examples could use some love #36

bdeitte opened this issue Nov 26, 2016 · 4 comments

Comments

@bdeitte
Copy link
Collaborator

bdeitte commented Nov 26, 2016

The README examples are ok but not the best. It would be nice to split out examples into different sections and make sure they all really make sense. The timings ones for instance should have a starting time and then subtract from the starting time using Date.now(), the most common use case. And the tags ones should use tags as they are really used in DataDog ("key:value").

I'm entering this as a known issue as the maintainer of this project, but I don't have the capacity to get to this anytime soon. If you do want to take this on, please feel free! I'm happy to give any advice, and I review updates quickly.

@jessb321
Copy link

Hey, I can have a look at this.

@eavestn
Copy link

eavestn commented Apr 13, 2018

@bdeitte or @willyb321 has anyone looked at this? They're pretty out of date (if the code base is indicative of changes).

@bdeitte
Copy link
Collaborator Author

bdeitte commented Apr 15, 2018

@eavestn I haven't seen any work come in on this. Happy to get a PR for any updates here.

@bdeitte
Copy link
Collaborator Author

bdeitte commented Dec 26, 2018

I made some small updates in there recently, but all the above is still valid and could still be taken on by anyone interested!

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

No branches or pull requests

3 participants