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

Beefed up influx client README #2095

Merged
merged 4 commits into from
Mar 27, 2015
Merged

Conversation

derailed
Copy link
Contributor

Left what was already there, but added much needed code samples to showcase the client API.

@corylanou
Copy link
Contributor

Great stuff. We should also add some files in the client package for example_test.go and put in appropriate examples so they show up in the generated GoDoc as well.

An example of how that is done is here:

https://github.com/golang/go/blob/439b32936367c3efd0dadab48dd51202e1a510f1/src/net/url/example_test.go

This can be done under a separate pull request as well.

@derailed
Copy link
Contributor Author

Tx Cory! Ask and you shall receive, my son...

Updated the PR to add the main client examples.

@corylanou
Copy link
Contributor

Awesome. +1 from me.

@otoolep
Copy link
Contributor

otoolep commented Mar 27, 2015

@derailed -- I don't see your name on the CLA. Can you please sign it?

Please refer to [http://godoc.org/github.com/influxdb/influxdb/client](http://godoc.org/github.com/influxdb/influxdb/client)
## Description

A Go client library written and maintain by the **InfluxDB** team.
Copy link
Contributor

Choose a reason for hiding this comment

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

maintain -> maintained

@corylanou
Copy link
Contributor


### Connecting To Your Database

Connecting to an **InfluxDB** database is straight forward. You will need a host
Copy link
Contributor

Choose a reason for hiding this comment

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

straightforward is one word.

@otoolep
Copy link
Contributor

otoolep commented Mar 27, 2015

Thanks @derailed -- this is very helpful. We just need some copy changes, and to make it clear there is no default user in 0.9, and we should be good to go. Don't forget the CLA.

@otoolep
Copy link
Contributor

otoolep commented Mar 27, 2015

@derailed -- here is the CLA:

http://influxdb.com/community/cla.html

@toddboom
Copy link
Contributor

👍 for me as well after the changes - this is awesome!

@derailed
Copy link
Contributor Author

Thank you all for the feedback! I've updated the PR per your comments.

@otoolep
Copy link
Contributor

otoolep commented Mar 27, 2015

Thanks for signing the CLA too @derailed

otoolep added a commit that referenced this pull request Mar 27, 2015
Beefed up influx client README
@otoolep otoolep merged commit 221097b into influxdata:master Mar 27, 2015
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

Successfully merging this pull request may close these issues.

4 participants