Prepare project for release to NPM registry (#8)

* Change name

* Remove compiled code

* Add dist directory to .gitignore

* Add pre / post publishing scripts

* Limit NPM tarball to dist directory only

* Add optional dependency installation to pre publish script

* Bump version in version file

* Set version in package.json to unversioned

* Add license file and update license in package.json

* Update README

Co-authored-by: Damian Dunajski <[email protected]>

Author: DamianDunajski

.gitignore

@@ -7,3 +7,4 @@ test.ts
 .python-version
 /coverage
 .settings
+dist/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Companies House
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -6,15 +6,15 @@ This SDK abstract the calls to our public APIs.
 
 Use NPM to install the SDK in your project;
 
-    npm i git+ssh://[email protected]:companieshouse/api-sdk-node.git
+    npm i @companieshouse/api-sdk-node
 
 Note that this install may need to be run with the 'sudo' command to avoid an error related to file permissions (and Sophos virus scanning).
 
 The following snippet shows how to get up and running quickly using TypeScript.
 
 ```typescript
 
-import {createApiClient} from "api-sdk-node";
+import {createApiClient} from "@companieshouse/api-sdk-node";
 
 (async () => {
     const api = createApiClient("your-api-key");
@@ -28,7 +28,7 @@ import {createApiClient} from "api-sdk-node";
 There is an alternative way of calling some of the services, which forces you to check for errors. It borrows concepts from the Either class found in functional programming.
 ```typescript
 
-import {createApiClient} from "api-sdk-node";
+import {createApiClient} from "@companieshouse/api-sdk-node";
 
 (async () => {
     const api = createApiClient("your-api-key");
@@ -69,11 +69,3 @@ Note that if your local project is running within a Vagrant Virtual Machine, thi
 To tun the tests with coverage, pass the `--coverage` flag on the command line.
 
     npm t -- --coverage
-
-## Building a new version
-
-When you want to release a new version, you first need to compile the TypeScript code.
-
-    npm run build
-
-This will output the generated JavaScript, Declaration files and Source Maps to the [dist](./dist) directory. The generated source code needs to be committed under version control as there is no internal npm registry yet.