Merge pull request #2 from UnofficialDathost/Development

0.0.2

.github/workflows/Development.yml

@@ -28,3 +28,5 @@ jobs:
           npm run test
       - name: Build with esbuild
         run: npm run build
+      - name: Build docs
+        run: npm run docs

.github/workflows/Production.yml

@@ -34,13 +34,25 @@ jobs:
         env:
           ACTIONS_ALLOW_UNSECURE_COMMANDS: 'true'
         run: echo ::set-env name=DATHOST_VERSION::$(npm info dathost version)
+      - name: Delete npmrc
+        run: rm -f ./.npmrc
       - name: Build with esbuild
         run: npm run build
       - name: Automatic Releases
         uses: marvinpinto/action-automatic-releases@v1.2.0
         with:
           repo_token: "${{ secrets.GITHUB_TOKEN }}"
-          automatic_release_tag: "latest"
+          automatic_release_tag: "Version ${{ env.DATHOST_VERSION }}"
           prerelease: false
           title: "${{ env.DATHOST_VERSION }}"
-          files: dist/**
+          files: dist/**
+      - name: Build docs
+        run: npm run docs
+      - name: Upload docs to dathost.wardpearce.com
+        uses: SamKirkland/FTP-Deploy-Action@4.0.0
+        with:
+          server: ${{ secrets.FTP_SERVER }}
+          username: ${{ secrets.FTP_USER }}
+          password: ${{ secrets.FTP_PASSWORD }}
+          local-dir: ./docs/
+          server-dir: ts/docs/

DOCSINTRO.md

@@ -0,0 +1,17 @@
+## Welcome to the Unofficial Dathost JS/TS wrapper Documentation
+
+### Starting point
+
+Look over the index documentation.
+
+### Example
+
+```ts
+import Dathost from 'dathost'
+
+const dathost = new Dathost('email', 'password')
+
+// Get account
+const account = await dathost.account()
+console.log(account.id, account.email, account.credits)
+```

README.md

@@ -1,2 +1,26 @@
-# TypeScript
-TypeScript wrapper for Dathost's API
+## Welcome to Dathost's unofficial ts/js wrapper!
+
+This is a unofficial asynchronous wrapper for Dathost's API.
+
+### Features:
+
+* Full API coverage.
+* Easy to use with an object oriented design.
+* 100% test coverage.
+* Modern Typescript
+
+### Install
+
+- npm: `npm install dathost`
+- browser: [Releases](https://github.com/UnofficialDathost/TypeScript/releases)
+
+### Documentation
+
+[Documentation](http://dathost.wardpearce.com/ts/docs)
+
+### Commands
+
+- `npm run test` - Run unit tests
+- `npm run lint` - Lints code
+- `npm run build` - Builds code to javascript
+- `npm run docs` - Builds docs