Prepare files for release v3.0.0

Dockerfile

@@ -1,12 +1,12 @@
 FROM bhekanik/firebase:latest
 
-LABEL version="1.0.0"
+LABEL version="3.0.0"
 LABEL repository="https://github.com/IIIMPACT/firebase-firestore-testing-action.git"
 LABEL homepage="https://github.com/IIIMPACT/firebase-firestore-testing-action.git"
-LABEL maintainer="Bhekani Khumalo <bhekani@iiimpact.io>"
+LABEL maintainer="Bhekani Khumalo <bhekani@gmail.com>"
 
-LABEL com.github.actions.name="Firebase Firestore Testing"
-LABEL com.github.actions.description="Test firestore with the emulators and jest."
+LABEL com.github.actions.name="Jest testing (including firestore rules)"
+LABEL com.github.actions.description="Run jest to test code, this includes the firebase firestore emulator to make it possible to also test firestore rules."
 LABEL com.github.actions.icon="airplay"
 LABEL com.github.actions.color="orange"
 

README.md

@@ -1,3 +1,45 @@
-# firebase-firestore-testing-action
+## Jest testing (including firestore rules)
 
-This action allows you to use the firestore emulator and jest to test firestore rules in ci
+This action runs jest to test code. It also includes the firebase firestore emulator to make it possible to also test firestore rules.
+
+## Assumptions
+
+This action assumes that:
+
+* Your file structure contains a folder in the root directory called `funcitons` which contains all your functions code.
+* You have the following npm scripts in your `package.json`:
+
+```javascript
+...
+  "scripts": {
+    "test": "jest",
+    "test:ci": "firebase emulators:exec --only firestore \"npm run test\"",
+  }
+...
+```
+
+## Example
+
+Here is an example yaml file to run the action:
+
+```yaml
+name: Test
+
+on: [pull_request]
+
+jobs:
+  test:
+    name: test
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v1
+
+      - name: Run Jest
+        uses: IIIMPACT/[email protected]
+```
+
+## License
+
+The Dockerfile and associated scripts and documentation in this project are released under the [MIT License](LICENSE).

action.yml

@@ -1,7 +1,6 @@
-# action.yml
-name: 'Firebase Firestore Testing'
-author: 'Bhekani Khumalo'
-description: 'Test firestore with the emulators and jest.'
+name: 'Jest testing (including firestore rules)'
+author: 'Bhekani Khumalo <[email protected]>'
+description: 'Run jest to test code, this includes the firebase firestore emulator to make it possible to also test firestore rules.'
 branding:
   icon: 'airplay'
   color: 'orange'

entrypoint.sh

@@ -15,9 +15,5 @@ else
     fi
 fi
 
-echo "## Starting emulator"
-sh -c "firebase serve --only firestore"
-
 echo "## Running Jest"
-args=$@
-sh -c "$setup npm --prefix functions run test:ci $args"
+sh -c "$setup npm --prefix functions run test:ci"