Skip to content

Commit

Permalink
Initial doc version
Browse files Browse the repository at this point in the history
  • Loading branch information
hhkaos authored Jan 9, 2020
1 parent 08ed968 commit c75d054
Showing 1 changed file with 3 additions and 13 deletions.
16 changes: 3 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,13 @@
# koop-cli-new-project
# koop-provider-public-google-sheets

A minimal Koop project template from [Koop CLI](https://github.com/koopjs/koop-cli).

See the [specification](https://koopjs.github.io/docs/usage/koop-core) for more details.
Unlike [this provider](https://github.com/koopjs/koop-provider-google-sheets), it does not need to set up any Google keys to access Google Sheets data as it is feed from public spreadsheets.

## Configuration

This project is configured with [config](https://www.npmjs.com/package/config). As a community practice, it is recommanded to namespace the configuration for plugins in order to avoid any potential key conflict.
No need

## Development

### Testing

This project uses [mocah](https://www.npmjs.com/package/mocha) as the testing framework and [chaijs](https://www.chaijs.com/) as the assertion library. All test files in the `test` directory should have the special extension `.test.js`, which will be executed by the command:

```
$ npm test
```

### Dev Server

This project by default uses the [Koop CLI](https://github.com/koopjs/koop-cli) to set up the dev server. It can be invoded via
Expand Down

0 comments on commit c75d054

Please sign in to comment.