Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
bloodstorms committed Nov 10, 2022
1 parent 1340571 commit a6703e6
Showing 1 changed file with 16 additions and 11 deletions.
27 changes: 16 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,20 @@ Last but not least, you can **play with Weaverbird on our [online playground](ht
## Badges

### UI

[![npm](https://img.shields.io/npm/v/weaverbird)](https://www.npmjs.com/package/weaverbird)
![CI UI](https://github.com/ToucanToco/weaverbird/actions/workflows/ci-ui.yml/badge.svg)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=ToucanToco_weaverbird&metric=coverage)](https://sonarcloud.io/dashboard?id=ToucanToco_weaverbird)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=ToucanToco_weaverbird&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=ToucanToco_weaverbird)
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=ToucanToco_weaverbird&metric=ncloc)](https://sonarcloud.io/dashboard?id=ToucanToco_weaverbird)

<!-- [![Codecov Coverage](https://img.shields.io/codecov/c/github/ToucanToco/weaverbird.svg?style=flat-square)](https://codecov.io/gh/ToucanToco/weaverbird/) -->

### Server

[![pypi](https://img.shields.io/pypi/v/weaverbird)](https://pypi.org/project/weaverbird/)
![CI server](https://github.com/ToucanToco/weaverbird/actions/workflows/ci-server.yml/badge.svg)


## Project setup

```bash
Expand Down Expand Up @@ -109,9 +111,10 @@ permalink: /docs/your-page-doc-name/
---
```

> to finish to get your page into the doc navigation you have to add it in `_data/docs.yml``
> to finish to get your page into the doc navigation you have to add it in `\_data/docs.yml``
example :

```
- title: Technical documentation
docs:
Expand Down Expand Up @@ -148,12 +151,14 @@ This library is published on npm under the name `weaverbird` automatically each
- Update the `version` property in `package.json` and in `sonar-project.properties`

- Check differences between last release and current and fill `CHANGELOG.md` with updates
- Delete the ```##changes``` title at start of the `CHANGELOG.md` if provided

- Delete the `##changes` title at start of the `CHANGELOG.md` if provided
- Add the date and version at start of `CHANGELOG.md` following this convention

```
[X.Y.Z] - YYYY-MM-DD
```

ex: `[0.20.0] - 2020-08-03`

- Add link to the `CHANGELOG.md` from this version to the previous one at the end of the `CHANGELOG.md`
Expand Down Expand Up @@ -206,7 +211,7 @@ This library is published on npm under the name `weaverbird` automatically each
### With an ES module bundler (typically webpack, vite or rollup)

```js
import { Pipeline } from 'weaverbird';
import { Pipeline } from "weaverbird";
```

> By default, the CommonJS module is imported. If you prefer the ES module
Expand Down Expand Up @@ -254,11 +259,11 @@ Once the server is started, you should be able to open the

> When developing the UI, use `yarn vite` that provides its own dev server.

### Mongo back-end

The default back-end for the playground is a small server passing queries to MongoDB.
Connect the playground to a running MongoDB instance with the environment variables:

- MONGODB_CONNECTION_STRING (default to localhost:27017)
- MONGODB_DATABASE_NAME (default to 'data')

Expand All @@ -284,11 +289,11 @@ Add `?backend=pandas` to the URL to see it in action.
In order to run the playground with AWS Athena, make sure the following environment variables are set before starting the
docker-compose stack:

* `ATHENA_REGION`
* `ATHENA_SECRET_ACCESS_KEY`
* `ATHENA_ACCESS_KEY_ID`
* `ATHENA_DATABASE`
* `ATHENA_OUTPUT`
- `ATHENA_REGION`
- `ATHENA_SECRET_ACCESS_KEY`
- `ATHENA_ACCESS_KEY_ID`
- `ATHENA_DATABASE`
- `ATHENA_OUTPUT`

### BigQuery back-end

Expand All @@ -301,7 +306,7 @@ CSVs from `playground/datastore` are available to use in the playground with pan
You can override this folder when running the container using by adding a volume parameter:
`-v /path/to/your/folder/with/csv:/weaverbird/playground/datastore`.

### Use another front-end
### Use another back-end

You can point a front-end to another API by using a query parameter: `?api=http://localhost:5000`.
This is particularly useful for front-end development, with `yarn vite`.
Expand Down

0 comments on commit a6703e6

Please sign in to comment.