Update docs, first attempt at GitHub actions

Author: LordGrimmauld

.github/workflows/gradle.yml

@@ -0,0 +1,31 @@
+name: Node.js CI
+
+on:
+    push:
+        branches: "**"
+    pull_request:
+        branches: "**"
+
+jobs:
+    build:
+
+        runs-on: ubuntu-latest
+
+        strategy:
+            matrix:
+                node-version: [ 16.x ]
+
+        steps:
+            - uses: actions/checkout@v3
+            - name: Use Node.js ${{ matrix.node-version }}
+              uses: actions/setup-node@v3
+              with:
+                  node-version: ${{ matrix.node-version }}
+            - run: npm ci
+            - run: npm run build --if-present
+            - uses: actions/upload-artifact@v2
+              with:
+                  name: Package
+                  path:
+                    - main.js
+                    - package.json

CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Development
+To contribute, anyone can make Pull Requests. Considering this is a hobby project, they may or may not be merged, and merges may take a while depending on my available schedule.
+To start contributing, reading the Obsidian plugin *getting started* entry on the [obsidian forum](https://forum.obsidian.md/t/how-to-get-started-with-developing-a-custom-plugin/8157/3) may help.
+For documentation on watchers for ActivityWatch, the [ActivityWatch watcher documentation](https://docs.activitywatch.net/en/latest/examples/writing-watchers.html) might help. Just keep in mind Obsidian does not allow post requests using axios or fetch due to CORS policy. There is an official JS client for ActivityWatch at https://github.com/ActivityWatch/aw-client-js, but it does not work due to using axios instead of the unrestricted request of the Obsidian API. Any requests to ActivityWatch API being made need to be rewritten to use the Obsidian request API.
+
+## Requirements
+Any change made must satisfy the requirements of [Obsidian's plugin review](https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md). Changes should also be as unobtrusive to previously collected userdata as possible to not break existing installations. Further, contributions must satisfy GitHub TOS, which includes anyone only contributing code they have permission to use, either by writing themselves, by license or explicitly.
+I ask to not trigger the version bump tool in npm as that is the last step that happens before a release is made.
+
+## Building
+During testing of development, `npm run dev` will continuously check for files being changed and run the build task. If you clone this repository directly into the plugins folder of an obsidian vault, simply reloading obsidian or disabling and reneabling the plugin in the community plugins tab will load the newly compiled version after changes have been made.
+During development, it is advisable to start your ActivityWatch server using `aw-server --testing` or `aw-server --testing --verbose` and switching to development server in the plugin settings inside obsidian. That way the plugin will not access your ActivityWatch production server.
+To build a version for production, `npm run build` has to be triggered. However, this is only relevant if installing patched versions manually without a proper release as well as making sure the plugin actually builds.

README.md

@@ -1,5 +1,5 @@
 # ActivityWatch and Obsidian compatibility
-ActivityWatch (https://activitywatch.net/) is an open source time tracker capable of keeping track how much time is spent using which program. To get detailed info, ActivityWatch allows adding *Watchers* capable of sending relevant information to the ActivityWatch API.
+[ActivityWatch](https://activitywatch.net/) is an open source time tracker capable of keeping track how much time is spent using which program. To get detailed info, ActivityWatch allows adding *Watchers* capable of sending relevant information to the ActivityWatch API.
 
 ## How do I use it?
 aw-watcher-obsidian is an ActivityWatch watcher watching the user activity in Obsidian vaults with the plugin active. The watcher currently tracks the name of the vault as well as the name of the currently active markdown file. The timeline and activity view in the evaluation screen of ActivityWatch will then be capable of telling the user how much time they spent on which file.
@@ -8,10 +8,5 @@ To install, either get it from Obsidians community plugins list \[as of writing
 ## Where is my data going?
 The data being collected by this plugin is sent to the ActivityWatch server running on localhost, which means the data does not leave your local machine at first. ActivityWatch does allow sharing data over multiple devices, but this Plugin does not do that by itself.
 
-## Development
-To contribute, anyone can make Pull Requests. Considering this is a hobby project, they may or may not be merged, and merges may take a while depending on my available schedule.
-To start contributing, reading the Obsidian plugin *getting started* entry on the obsidian forum (https://forum.obsidian.md/t/how-to-get-started-with-developing-a-custom-plugin/8157/3) may help.
-For documentation on watchers for ActivityWatch, the documentation entry at https://docs.activitywatch.net/en/latest/examples/writing-watchers.html might help. Just keep in mind Obsidian does not allow post requests using axios or fetch due to CORS policy. There is an official JS client for ActivityWatch at https://github.com/ActivityWatch/aw-client-js, but it does not work due to using axios instead of the unrestricted request of the Obsidian API. Any requests to ActivityWatch API being made need to be rewritten to use the Obsidian request API.
-
 ## Credits
 To build the watcher API used in this project I tightly followed the official API at https://github.com/ActivityWatch/aw-client-js.