Merge pull request #51 from MelanX/curseforge-service

Add docs for CurseForge service

Author: hlxid

.gitignore

@@ -1 +1,3 @@
-build/
+build/
+.idea
+.vscode

docs/index.md

@@ -1,6 +1,6 @@
 # nodecg-io
 
-![](assets/header_white.png)
+![nodecg-io logo](assets/header_white.png)
 
 [![Feature Requests](https://img.shields.io/github/issues/codeoverflow-org/nodecg-io/enhancement?label=Feature%20Requests&style=flat-square)](https://github.com/codeoverflow-org/nodecg-io/labels/enhancement)
 [![Bugs](https://img.shields.io/github/issues/codeoverflow-org/nodecg-io/bug?label=Bugs&style=flat-square)](https://github.com/codeoverflow-org/nodecg-io/labels/bug)
@@ -25,6 +25,7 @@ If that's no problem you can head over to the [installation guide](https://nodec
 
 -   [x] AutoHotkey
 -   [x] Android (using adb)
+-   [x] CurseForge
 -   [x] Discord
 -   [x] IntelliJ IDEs
 -   [x] IRC (Internet Relay Chat)

docs/samples/curseforge.md

@@ -0,0 +1,16 @@
+## Using the CurseForge sample bundle
+
+The CurseForge example bundle in `samples/curseforge` demonstrates the ability to search for different addons with the id or search with specific values for matching addons. Here is a guide how to get it working.
+
+### Prerequisites
+
+- Working NodeCG & nodecg-io installation
+
+### Configure the CurseForge bundle
+
+1. Start NodeCG with with nodecg-io installed. The CurseForge bundle is currently part of it, so it should also be loaded.
+2. Login using your password. If this is your first run, then enter the password with which you want to encrypt your configurations and credentials.
+3. Create a new CurseForge service instance using the left upper menu.
+4. Set the CurseForge service instance to the service dependency of the CurseForge bundle. 
+    Select the CurseForge bundle the the CurseForge service in the left bottom menu and then select the service instance that should be used by the CurseForge bundle (in this case the name of the previously created CurseForge instance).
+5. Check the NodeCG logs. You should see two lists of addons.

docs/services.md

@@ -31,7 +31,7 @@ Depends on [get-stream](https://www.npmjs.com/package/get-stream) @ 6.0.0 <br>
 
 **A service to communicate with the CurseForge API.**
 
-There's no sample implementation for this service yet.
+See the [sample implementation](samples/curseforge.md)
 
 Depends on [nodecg-io-core](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-core) @ ^0.1.0 <br>
 Depends on [node-fetch](https://www.npmjs.com/package/node-fetch) @ ^2.6.1 <br>

mkdocs.yml

@@ -49,6 +49,7 @@ nav:
     - Services:
           - Available services: services.md
           - AHK sample: samples/ahk.md
+          - Curseforge sample: samples/curseforge.md
           - Android: samples/android.md
           - Discord sample: samples/discord.md
           - IntelliJ sample: samples/intellij.md