From 111b92703329ff78ade876f5d3dfab2b06375fd5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Garc=C3=ADa=20Aubert?= Date: Mon, 30 Dec 2019 12:43:00 +0100 Subject: [PATCH] Minor doc fixes --- HOW_TO_RELEASE.md | 4 ++-- README.md | 6 +++--- package.json | 6 ++++-- 3 files changed, 9 insertions(+), 7 deletions(-) diff --git a/HOW_TO_RELEASE.md b/HOW_TO_RELEASE.md index df017f17..eb395516 100644 --- a/HOW_TO_RELEASE.md +++ b/HOW_TO_RELEASE.md @@ -1,4 +1,4 @@ -How to release: +# How to release 1. Test (npm test), fix if broken before proceeding. 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. 7. Stub NEWS/package for next version. -Versions: +## Version: * Bugfix releases increment Patch component of version. * Feature releases increment Minor and set Patch to zero. diff --git a/README.md b/README.md index a0cd75cd..c7f7dde0 100644 --- a/README.md +++ b/README.md @@ -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) -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)). * 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 -Create the `./config/environments/.js` file (there are `.example` files to start from). Look at `./lib/cartodb/server-options.js` for more on config. +Create the `./config/environments/.js` file (there are `.example` files to start from). Look at `./lib/server-options.js` for more on config. ```shell $ node app.js @@ -119,7 +119,7 @@ $ npm link windshaft ## 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 diff --git a/package.json b/package.json index f20f56f4..964bd6c4 100644 --- a/package.json +++ b/package.json @@ -20,17 +20,19 @@ "type": "git", "url": "git://github.com/CartoDB/Windshaft-cartodb.git" }, - "author": "Vizzuality (http://vizzuality.com)", + "author": "CARTO (https://carto.com)", "contributors": [ "Simon Tokumine ", "Javi Santana ", + "Raúl Ochoa ", "Sandro Santilli ", "Carlos Matallín ", - "Daniel Garcia Aubert ", + "Daniel García Aubert ", "Mario de Frutos ", "Ivan Malagon ", "Simon Martin " ], + "main": "app.js", "dependencies": { "@carto/fqdn-sync": "0.2.2", "basic-auth": "2.0.0",