feat(package): Rename package name from govuk-api to govuk

NickColley · May 12, 2023 · 204e3c8 · 204e3c8
1 parent cc3b108
commit 204e3c8
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 JavaScript API client for GOV.UK Content and Search APIs.
 
-[![GOVUK API latest npm version](https://img.shields.io/npm/v/govuk-api.svg?v=2)](https://www.npmjs.com/package/govuk-api)
+[![GOVUK API latest npm version](https://img.shields.io/npm/v/govuk.svg?v=2)](https://www.npmjs.com/package/govuk)
 
 ## Contents
 
@@ -17,12 +17,12 @@ JavaScript API client for GOV.UK Content and Search APIs.
 
 ```bash
 npm init mjs -y # initialise module-ready package.json
-npm install govuk-api
+npm install govuk
 ```
 
 ```javascript
 // index.js;
-import { SearchAPI, ContentAPI } from "govuk-api";
+import { SearchAPI, ContentAPI } from "govuk";
 
 const searchApi = new SearchAPI();
 const contentApi = new ContentAPI();
@@ -44,7 +44,7 @@ node index.js
 ```html
 <!-- index.html -->
 <script type="module">
-  import { SearchAPI, ContentAPI } from "https://unpkg.com/govuk-api";
+  import { SearchAPI, ContentAPI } from "https://unpkg.com/govuk";
 
   const searchApi = new SearchAPI();
   const contentApi = new ContentAPI();
@@ -80,7 +80,7 @@ Returns a [content item](https://content-api.publishing.service.gov.uk/reference
 #### Getting data from resolved promise
 
 ```javascript
-import { ContentAPI } from "govuk-api";
+import { ContentAPI } from "govuk";
 const api = new ContentAPI();
 const contentItem = await api.get("Register-to-vote");
 console.log(contentItem);
@@ -89,7 +89,7 @@ console.log(contentItem);
 #### Getting data from event
 
 ```javascript
-import { ContentAPI } from "govuk-api";
+import { ContentAPI } from "govuk";
 const api = new ContentAPI();
 api.on("data", (contentItem) => {
   console.log(contentItem);
@@ -115,7 +115,7 @@ Set the default query and options for all other calls to `get`, `getAll` and `to
 #### Getting data from resolved promise
 
 ```javascript
-import { SearchAPI } from "govuk-api";
+import { SearchAPI } from "govuk";
 const api = new SearchAPI("Micro pig", { count: 10 });
 const searchResults = await api.get();
 console.log(searchResults);
@@ -133,7 +133,7 @@ Get first page of search items for a query
 #### Getting data from resolved promise
 
 ```javascript
-import { SearchAPI } from "govuk-api";
+import { SearchAPI } from "govuk";
 const api = new SearchAPI();
 const searchResults = await api.get("Micro pig");
 console.log(searchResults);
@@ -142,7 +142,7 @@ console.log(searchResults);
 #### Getting data from event
 
 ```javascript
-import { SearchAPI } from "govuk-api";
+import { SearchAPI } from "govuk";
 const api = new SearchAPI();
 api.on("data", (searchResults) => {
   console.log(searchResults);
@@ -163,7 +163,7 @@ Get all pages of search items for a query.
 #### Getting data from resolved promise
 
 ```javascript
-import { SearchAPI } from "govuk-api";
+import { SearchAPI } from "govuk";
 const api = new SearchAPI();
 const searchResults = await api.getAll("Micro pig");
 console.log(searchResults);
@@ -172,7 +172,7 @@ console.log(searchResults);
 #### Getting data from event
 
 ```javascript
-import { SearchAPI } from "govuk-api";
+import { SearchAPI } from "govuk";
 const api = new SearchAPI();
 api.on("data", (searchResults) => {
   console.log(searchResults);
@@ -191,7 +191,7 @@ Get metadata for a content item.
 #### Getting info from resolved promise
 
 ```javascript
-import { SearchAPI } from "govuk-api";
+import { SearchAPI } from "govuk";
 const api = new SearchAPI();
 const contentInfo = await api.info("register-to-vote");
 console.log(contentInfo);
@@ -209,7 +209,7 @@ Get total amount of search items for a query.
 #### Getting total from resolved promise
 
 ```javascript
-import { SearchAPI } from "govuk-api";
+import { SearchAPI } from "govuk";
 const api = new SearchAPI();
 const totalResults = await api.total("Micro pig");
 console.log(totalResults);
@@ -226,7 +226,7 @@ Get facets for a field.
 #### Getting facets from resolved promise
 
 ```javascript
-import { SearchAPI } from "govuk-api";
+import { SearchAPI } from "govuk";
 const api = new SearchAPI();
 const facets = await api.facets("formats");
 console.log(facets);

diff --git a/examples/streaming-content-to-json/index.js b/examples/streaming-content-to-json/index.js
@@ -1,5 +1,5 @@
 import { createWriteStream } from "node:fs";
-import { ContentAPI, SearchAPI } from "govuk-api";
+import { ContentAPI, SearchAPI } from "govuk";
 import JSONTransform from "./json-transform.js";
 
 const query = "Potato";

diff --git a/examples/streaming-content-to-json/package.json b/examples/streaming-content-to-json/package.json
@@ -10,6 +10,6 @@
   },
   "license": "MIT",
   "dependencies": {
-    "govuk-api": "../../"
+    "govuk": "../../"
   }
 }
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "type": "module",
-  "name": "govuk-api",
+  "name": "govuk",
   "description": "JavaScript API client for GOV.UK Content and Search APIs.",
   "version": "0.0.0-development",
   "source": "index.js",
@@ -48,7 +48,7 @@
     "semantic-release": "^19.0.5"
   },
   "engines": {
-    "node": "16.x"
+    "node": ">=16.x"
   },
   "publishConfig": {
     "access": "public"