Improved docs README page

Signed-off-by: David Arendsen <darendsen@gamepoint.com>
This commit is contained in:
David Arendsen 2023-01-01 12:36:01 +01:00
commit cd170e7eff

View file

@ -1,27 +1,24 @@
# InfluxDB 2.x Flux Query Builder
# Flux Query Builder
With this query builder you can build queries for Flux. Flux is a powerful open source query language created by the makers of InfluxDB. See https://www.influxdata.com/products/flux/
## Installation
```
composer require arendsen/fluxquerybuilder
```
## Documentation
The documentation of this project is available in the [docs folder](docs/00-index.md).
Go directly to our [Getting started page](docs/01-getting-started.md)
## Testing
## Contributing
You're welcome to contribute to this project, but please add tests and follow the coding style.
### Testing
To execute the testing suite:
```
composer test
```
## Coding style
### Coding style
Run the following commands to check and fix the coding style. We're using the PSR12 standard.