Improved docs README page
Signed-off-by: David Arendsen <darendsen@gamepoint.com>
This commit is contained in:
parent
c728f721e5
commit
cd170e7eff
1 changed files with 6 additions and 9 deletions
15
README.md
15
README.md
|
|
@ -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/
|
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
|
## Documentation
|
||||||
The documentation of this project is available in the [docs folder](docs/00-index.md).
|
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)
|
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:
|
To execute the testing suite:
|
||||||
|
|
||||||
```
|
```
|
||||||
composer test
|
composer test
|
||||||
```
|
```
|
||||||
|
|
||||||
## Coding style
|
### Coding style
|
||||||
|
|
||||||
Run the following commands to check and fix the coding style. We're using the PSR12 standard.
|
Run the following commands to check and fix the coding style. We're using the PSR12 standard.
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
editor.link_modal.header
Reference in a new issue