cartodb/Windshaft-cartodb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor doc fixes

Browse Source
This commit is contained in:
Daniel García Aubert 2019-12-30 12:43:00 +01:00
parent d63337f06f
commit 111b927033
3 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
HOW_TO_RELEASE.md
View File

@ -1,4 +1,4 @@
How to release: # How to release
1. Test (npm test), fix if broken before proceeding. 1. Test (npm test), fix if broken before proceeding.
2. Ensure proper version in `package.json` and `package-lock.json`. 2. Ensure proper version in `package.json` and `package-lock.json`.
@ -8,7 +8,7 @@ How to release:
6. Run `git tag -a Major.Minor.Patch`. Use NEWS section as content. 6. Run `git tag -a Major.Minor.Patch`. Use NEWS section as content.
7. Stub NEWS/package for next version. 7. Stub NEWS/package for next version.
Versions: ## Version:
* Bugfix releases increment Patch component of version. * Bugfix releases increment Patch component of version.
* Feature releases increment Minor and set Patch to zero. * Feature releases increment Minor and set Patch to zero.

6
README.md
View File

@ -1,6 +1,6 @@
# Windshaft-CartoDB [![Build Status](https://travis-ci.org/CartoDB/Windshaft-cartodb.svg?branch=master)](https://travis-ci.org/CartoDB/Windshaft-cartodb) # Windshaft-CartoDB [![Build Status](https://travis-ci.org/CartoDB/Windshaft-cartodb.svg?branch=master)](https://travis-ci.org/CartoDB/Windshaft-cartodb)
The [`CARTO Maps API`](http://docs.cartodb.com/cartodb-platform/maps-api.html) tiler. It extends [`Windshaft`](https://github.com/CartoDB/Windshaft) and exposes a web service with extra functionality: The [`CARTO Maps API`](https://carto.com/developers/maps-api/) tiler. It extends [`Windshaft`](https://github.com/CartoDB/Windshaft) and exposes a web service with extra functionality:
* Instantiate [`Anonymous Maps`](https://github.com/CartoDB/Windshaft-cartodb/blob/master/docs/guides/03-anonymous-maps.md) through CARTO's map configuration ([`MapConfig`](https://github.com/CartoDB/Windshaft/blob/master/doc/MapConfig-specification.md)). * Instantiate [`Anonymous Maps`](https://github.com/CartoDB/Windshaft-cartodb/blob/master/docs/guides/03-anonymous-maps.md) through CARTO's map configuration ([`MapConfig`](https://github.com/CartoDB/Windshaft/blob/master/doc/MapConfig-specification.md)).
* Create [`Named Maps`](https://github.com/CartoDB/Windshaft-cartodb/blob/master/docs/guides/04-named-maps.md) based on customizable templates. * Create [`Named Maps`](https://github.com/CartoDB/Windshaft-cartodb/blob/master/docs/guides/04-named-maps.md) based on customizable templates.
@ -45,7 +45,7 @@ $ npm install
### Run ### Run
Create the `./config/environments/<env>.js` file (there are `.example` files to start from). Look at `./lib/cartodb/server-options.js` for more on config. Create the `./config/environments/<env>.js` file (there are `.example` files to start from). Look at `./lib/server-options.js` for more on config.
```shell ```shell
$ node app.js <env> $ node app.js <env>
@ -119,7 +119,7 @@ $ npm link windshaft
## Versioning ## Versioning
We follow [`SemVer`](http://semver.org/) for versioning. For available versions, see the [tags on this repository](https://github.com/Windshaft-cartodb/cartonik/tags). We follow [`SemVer`](http://semver.org/) for versioning. For available versions, see the [tags on this repository](https://github.com/CartoDB/Windshaft-cartodb/tags).
## License ## License

6
package.json
View File

@ -20,17 +20,19 @@
"type": "git", "type": "git",
"url": "git://github.com/CartoDB/Windshaft-cartodb.git" "url": "git://github.com/CartoDB/Windshaft-cartodb.git"
}, },
"author": "Vizzuality <contact@vizzuality.com> (http://vizzuality.com)", "author": "CARTO (https://carto.com)",
"contributors": [ "contributors": [
"Simon Tokumine <simon@vizzuality.com>", "Simon Tokumine <simon@vizzuality.com>",
"Javi Santana <jsantana@vizzuality.com>", "Javi Santana <jsantana@vizzuality.com>",
"Raúl Ochoa <rochoa@carto.com>",
"Sandro Santilli <strk@vizzuality.com>", "Sandro Santilli <strk@vizzuality.com>",
"Carlos Matallín <matallo@carto.com>", "Carlos Matallín <matallo@carto.com>",
"Daniel Garcia Aubert <dgaubert@carto.com>", "Daniel García Aubert <dgaubert@carto.com>",
"Mario de Frutos <mario.defrutos@carto.com>", "Mario de Frutos <mario.defrutos@carto.com>",
"Ivan Malagon <ivan@carto.com>", "Ivan Malagon <ivan@carto.com>",
"Simon Martin <simon@carto.com>" "Simon Martin <simon@carto.com>"
], ],
"main": "app.js",
"dependencies": { "dependencies": {
"@carto/fqdn-sync": "0.2.2", "@carto/fqdn-sync": "0.2.2",
"basic-auth": "2.0.0", "basic-auth": "2.0.0",