Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tdely committed Jun 29, 2021
1 parent e30a73f commit 1b0d800
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
Nimflux
=======

InfluxDB API client library for Nim.

Nimflux provides the InfluxClient type for communicating with the InfluxDB API.
InfluxClient can be used to `ping`, `write`, `query`, or send a custom `request`.
The DataPoint type is used to create measurements for `write`, although it is
also possible use your own Line Protocol string.
Nimflux is an InfluxDB API client library for Nim that can be used to `ping`,
`write`, `query`, or send custom `request`s. The `DataPoint` type is used to
easily create measurements for `write`, but it's also possible to send your own
Line Protocol string should the need arise.

```nim
import nimflux
Expand All @@ -22,7 +20,7 @@ resp = client.query("select * from temp")
echo resp.body
```

It also supports asynchronous actions through `AsyncInfluxClient`:
Asynchronous actions are also supported through `AsyncInfluxClient`:

```nim
import asyncdispatch, nimflux
Expand Down

0 comments on commit 1b0d800

Please sign in to comment.