Merge pull request #19 from fireblade-engine/feature/actions

Update documentation action

.github/workflows/documentation.yml

@@ -2,8 +2,12 @@ name: Documentation
 
 on:
   push:
-    branches:
-      - master
+    branches: [ master ]
+    paths:
+      - .github/workflows/documentation.yml
+      - Sources/FirebladeECS/**.swift
+  pull_request:
+    branches: [ master ]
     paths:
       - .github/workflows/documentation.yml
       - Sources/FirebladeECS/**.swift
@@ -13,16 +17,16 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - name: Checkout
-        uses: actions/checkout@v1
-      - name: Generate Documentation
-        uses: SwiftDocOrg/swift-doc@1.0.0-beta.3
+      - uses: actions/checkout@v1
+      - name: Generate documentation
+        uses: SwiftDocOrg/swift-doc@master
         with:
           inputs: "Sources/FirebladeECS"
           output: "Documentation"
-      - name: Publish to GitHub Wiki
-        uses: SwiftDocOrg/github-wiki-publish-action@1.0.0
+      - name: Publish to wiki
+        uses: SwiftDocOrg/github-wiki-publish-action@master
         with:
           path: "Documentation"
         env:
+          GITHUB_PERSONAL_ACCESS_TOKEN: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
           GH_PERSONAL_ACCESS_TOKEN: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}

README.md

@@ -9,7 +9,7 @@
 
 This is a **dependency free**, **lightweight**, **fast** and **easy to use** [Entity-Component System](https://en.wikipedia.org/wiki/Entity_component_system) implementation in Swift. It is developed and maintained as part of the [Fireblade Game Engine project](https://github.com/fireblade-engine).
 
-See the [Fireblade ECS Demo App](https://github.com/fireblade-engine/ecs-demo) to get started.
+See the [Fireblade ECS Demo App](https://github.com/fireblade-engine/ecs-demo) or have a look at [documentation in the wiki](https://github.com/fireblade-engine/ecs/wiki) to get started.
 
 ## 🚀 Getting Started
 
@@ -243,6 +243,10 @@ let newEntities = try family.decodeMembers(from: jsonData, using: &jsonDecoder)
 
 See the [Fireblade ECS Demo App](https://github.com/fireblade-engine/ecs-demo) to get started.
 
+## 📖 Documentation
+
+Consult the [wiki](https://github.com/fireblade-engine/ecs/wiki) for in-depth [documentation](https://github.com/fireblade-engine/ecs/wiki).
+
 ## 🏷️ Versioning
 
 We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/fireblade-engine/ecs/tags).