Feature/139 external user

.github/workflows/actions.yaml

@@ -14,8 +14,9 @@ jobs:
         with:
           node-version: 16.4.1
       - run: npm install
+      - run: npm run build
       - run: npm run lint
-      - run: npm test
+      - run: npm run test
 
   compile-contracts:
     name: Compiles contracts needed for bootstrap script

.vscode/extensions.json

@@ -1,6 +1,6 @@
 {
     "recommendations": [
-        "DavidAnson.vscode-markdownlint",
+        "davidanson.vscode-markdownlint",
         "dbaeumer.vscode-eslint",
         "streetsidesoftware.code-spell-checker"
     ]

.vscode/settings.json

@@ -5,5 +5,8 @@
     ],
     "editor.codeActionsOnSave": {
         "source.fixAll.eslint": true
-    }
+    },
+    "cSpell.words": [
+        "tonomy"
+    ]
 }

README.md

@@ -29,9 +29,19 @@ To do a one-off build, use `npm run build`.
 
 ## Tests
 
-To run tests, use `npm test`.
+### Unit tests:
 
-To run integration tests `./test-integration/build-and-run-tests.sh`
+Tests individual class and function logic within the SDK.
+
+`npm test`
+
+### Integration tests:
+
+Tests end-to-end functions across more than one service.
+
+Require another service to be running, such as the blockchain or Tonomy Communication service.
+
+`./test-integration/build-and-run-tests.sh`
 
 ## Linting
 

docs/login.rst

@@ -31,7 +31,7 @@ Login page
     async function onButtonPress() {
         setSettings({ ssoWebsiteOrigin: "https://tonomy-id-staging.tonomy.foundation" });
 
-        UserApps.onPressLogin({ callbackPath: '/callback' });
+        ExternalUser.loginWithTonomy({ callbackPath: '/callback' });
     }
 
 Callback page

docs/usage.rst

@@ -17,7 +17,7 @@ To use the SDK, first import it:
     async function onButtonPress() {
         setSettings({ ssoWebsiteOrigin: "https://tonomy-id-staging.tonomy.foundation" });
 
-        UserApps.onPressLogin({ callbackPath: '/callback' });
+        ExternalUser.loginWithTonomy({ callbackPath: '/callback' });
     }
 
 We can call the function ``onButtonPress()`` in the login implementation: