From 1ad3e8fe3722f507790f50796bf09ce280c4e062 Mon Sep 17 00:00:00 2001
From: Tim Schaub <tim.schaub@gmail.com>
Date: Fri, 20 Jul 2018 19:33:45 -0600
Subject: [PATCH] Changes for 5.1.1.

---
 README.md           | 47 +++++++++++++++++++++++++++++++-----------
 changelog/v5.1.1.md |  3 +++
 package.json        |  4 ++--
 src/ol/README.md    | 50 ---------------------------------------------
 4 files changed, 40 insertions(+), 64 deletions(-)
 create mode 100644 changelog/v5.1.1.md
 delete mode 100644 src/ol/README.md

diff --git a/README.md b/README.md
index e6ab49316e..588f6fe3f7 100644
--- a/README.md
+++ b/README.md
@@ -1,23 +1,44 @@
 # OpenLayers
 
-[![Travis CI Status](https://secure.travis-ci.org/openlayers/openlayers.svg)](http://travis-ci.org/#!/openlayers/openlayers)
-[![Greenkeeper badge](https://badges.greenkeeper.io/openlayers/openlayers.svg)](https://greenkeeper.io/)
-[![Coverage Status](https://coveralls.io/repos/github/openlayers/openlayers/badge.svg?branch=master)](https://coveralls.io/github/openlayers/openlayers?branch=master)
-[![OSGeo Project](https://img.shields.io/badge/OSGeo-Project-brightgreen.svg)](http://osgeo.org/)
-[![jsDelivr Hits](https://data.jsdelivr.com/v1/package/npm/openlayers/badge?style=rounded)](https://www.jsdelivr.com/package/npm/openlayers)
-
 [OpenLayers](https://openlayers.org/) is a high-performance, feature-packed library for creating interactive maps on the web. It can display map tiles, vector data and markers loaded from any source on any web page. OpenLayers has been developed to further the use of geographic information of all kinds. It is completely free, Open Source JavaScript, released under the 2-clause BSD License (also known as the FreeBSD).
 
 ## Getting Started
 
-Use one of the following methods to use OpenLayers in your project:
+Install the [`ol` package](https://www.npmjs.com/package/ol):
 
-* For use with webpack, Rollup, Browserify, or other module bundlers, install the [`ol` package](https://www.npmjs.com/package/ol):
-    ```
-    npm install ol
-    ```
+```
+npm install ol
+```
 
-* If you just want to add a `<script>` tag to test things out, you can link directly to one of the full builds from [cdnjs](https://cdnjs.com/libraries/openlayers) (not recommended for production)
+Import just what you need for your application:
+
+```js
+import Map from 'ol/Map';
+import View from 'ol/View';
+import TileLayer from 'ol/layer/Tile';
+import XYZ from 'ol/source/XYZ';
+
+new Map({
+  target: 'map',
+  layers: [
+    new TileLayer({
+      source: new XYZ({
+        url: 'https://{a-c}.tile.openstreetmap.org/{z}/{x}/{y}.png'
+      })
+    })
+  ],
+  view: new View({
+    center: [0, 0],
+    zoom: 2
+  })
+});
+```
+
+See the following examples for more detail on bundling OpenLayers with your application:
+
+ * Using [Rollup](https://github.com/openlayers/ol-rollup)
+ * Using [Webpack](https://github.com/openlayers/ol-webpack)
+ * Using [Parcel](https://github.com/openlayers/ol-parcel)
 
 ## Supported Browsers
 
@@ -39,3 +60,5 @@ Please see our guide on [contributing](CONTRIBUTING.md) if you're interested in
 
 - Need help? Find it on [Stack Overflow using the tag 'openlayers'](http://stackoverflow.com/questions/tagged/openlayers)
 - Follow [@openlayers](https://twitter.com/openlayers) on Twitter
+
+[![Build Status](https://travis-ci.org/openlayers/openlayers.svg?branch=master)](https://travis-ci.org/openlayers/openlayers)
diff --git a/changelog/v5.1.1.md b/changelog/v5.1.1.md
new file mode 100644
index 0000000000..d01cba52c4
--- /dev/null
+++ b/changelog/v5.1.1.md
@@ -0,0 +1,3 @@
+# 5.1.1
+
+The 5.1.1 release is a patch to include the readme in the package.  See the [5.1.0 notes](https://github.com/openlayers/openlayers/releases/tag/v5.0.3) for detail on the 5.1 release.
diff --git a/package.json b/package.json
index fd00f54f06..112734a561 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ol",
-  "version": "5.1.0",
+  "version": "5.1.1",
   "description": "OpenLayers mapping library",
   "keywords": [
     "map",
@@ -16,7 +16,7 @@
     "karma": "karma start test/karma.config.js",
     "serve-examples": "webpack-dev-server --config examples/webpack/config.js --mode development --watch",
     "build-examples": "webpack --config examples/webpack/config.js --mode production",
-    "build-package": "npm run transpile && npm run copy-css && node tasks/prepare-package",
+    "build-package": "npm run transpile && npm run copy-css && node tasks/prepare-package && cp README.md build/ol",
     "build-index": "npm run build-package && node tasks/generate-index",
     "build-legacy": "rm -rf build && npm run build-index && rollup --config config/rollup.js && cleancss --source-map src/ol/ol.css -o build/ol.css",
     "copy-css": "cp src/ol/ol.css build/ol/ol.css",
diff --git a/src/ol/README.md b/src/ol/README.md
deleted file mode 100644
index f435005329..0000000000
--- a/src/ol/README.md
+++ /dev/null
@@ -1,50 +0,0 @@
-# ol
-
-OpenLayers as ES modules.
-
-## Usage
-
-Add the `ol` package as a dependency to your project.
-
-    npm install ol --save
-
-Import just what you need for your application:
-
-```js
-import Map from 'ol/Map';
-import View from 'ol/View';
-import TileLayer from 'ol/layer/Tile';
-import XYZ from 'ol/source/XYZ';
-
-new Map({
-  target: 'map',
-  layers: [
-    new TileLayer({
-      source: new XYZ({
-        url: 'https://{a-c}.tile.openstreetmap.org/{z}/{x}/{y}.png'
-      })
-    })
-  ],
-  view: new View({
-    center: [0, 0],
-    zoom: 2
-  })
-});
-```
-
-See the following examples for more detail on bundling OpenLayers with your application:
-
- * Using [Rollup](https://github.com/openlayers/ol-rollup)
- * Using [Webpack](https://github.com/openlayers/ol-webpack)
- * Using [Parcel](https://github.com/openlayers/ol-parcel)
-
-## Module Identifiers
-
-The module identifiers shown in the above snippet (e.g. `ol/Map`, note the CamelCase module name) are default exports of constructors. There are also modules like 'ol/proj' (note the lowercase module name), which provide named exports for utility functions and constants, e.g.
-
-```js
-import {fromLonLat} from 'ol/proj';
-
-map.setCenter(fromLonLat([16, 48]));
-```
-See the [API documentation](http://openlayers.org/en/latest/apidoc/) for a reference of all modules, and just keep in mind: CamelCase modules provide a default export, lowercase modules provide named exports.