Merge pull request #276 from iotaledger/feat/rename-config

Rename config.json to config.default.json

.github/workflows/release.yml

@@ -15,6 +15,8 @@ jobs:
     steps:
     - name: Check out code into the Go module directory
       uses: actions/checkout@v2
+    - name: Copy config.default.json to config.json
+      run: cp config.default.json config.json
     - name: Release GoShimmer
       run: goreleaser --rm-dist
       env:

.gitignore

@@ -26,4 +26,6 @@ objectsdb/
 # OSX related files
 .DS_Store
 shimmer
-goshimmer
+goshimmer
\ No newline at end of file
+
+config.json
\ No newline at end of file

README.md

@@ -148,7 +148,16 @@ If Go is installed, you should see the version that's installed.
 
 2. Change into the `goshimmer` directory
 
-3. Use one of the following commands to build your executable file, depending on your operating system
+3. Copy and adjust `config.default.json`
+
+    ```bash
+    # Linux and macOS
+    cp config.default.json config.json
+    # Windows
+    copy config.default.json config.json
+    ```
+
+4. Use one of the following commands to build your executable file, depending on your operating system
 
     ```bash
     # Linux and macOS