Merge pull request #1 from Waradu/nightly

Author: 0PandaDEV

.github/workflows/build.yml

@@ -2,15 +2,15 @@ name: "Nightly Builds"
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
   workflow_dispatch:
     inputs:
       ref:
-        description: 'Branch or tag to build'
+        description: "Branch or tag to build"
         required: true
-        default: 'main'
+        default: "main"
         type: string
 
 env:
@@ -71,15 +71,15 @@ jobs:
           Type=Application
           Categories=Development;
           EOF
-          
+
           # Copy icon
           mkdir -p AppDir/usr/share/icons/hicolor/256x256/apps/
           cp .github/scope-round-200.png AppDir/usr/share/icons/hicolor/256x256/apps/scope.png
-          
+
           # Copy binary
           mkdir -p AppDir/usr/bin
           cp target/release/scope AppDir/usr/bin/
-          
+
           # Create AppImage
           wget -O linuxdeploy-x86_64.AppImage https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-x86_64.AppImage
           chmod +x linuxdeploy-x86_64.AppImage
@@ -205,7 +205,7 @@ jobs:
           mkdir -p Scope.app/Contents/{MacOS,Resources}
           cp target/x86_64-apple-darwin/release/scope Scope.app/Contents/MacOS/
           cp .github/scope-round-200.png Scope.app/Contents/Resources/scope.icns
-          
+
           cat > Scope.app/Contents/Info.plist << EOF
           <?xml version="1.0" encoding="UTF-8"?>
           <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
@@ -277,7 +277,7 @@ jobs:
           mkdir -p Scope.app/Contents/{MacOS,Resources}
           cp target/aarch64-apple-darwin/release/scope Scope.app/Contents/MacOS/
           cp .github/scope-round-200.png Scope.app/Contents/Resources/scope.icns
-          
+
           cat > Scope.app/Contents/Info.plist << EOF
           <?xml version="1.0" encoding="UTF-8"?>
           <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">

README.md

@@ -3,7 +3,7 @@
 <img width="128px" src="./.github/scope-round-200.png" />
 <h1><b>Scope</b></h1>
 
-The discord client for power users.
+The Discord client for power users.
 <br>
 <a href="https://www.scopeclient.com/"><strong>scopeclient.com »</strong></a>
 
@@ -15,13 +15,13 @@ The discord client for power users.
   </tbody>
 </table>
 
-<sup>Nightly releases can be found <a href="https://github.com/scopeclient/scope/actions/workflows/build.yml">here</a> </sup>
+<sup>Nightly releases can be found <a href="https://github.com/scopeclient/scope/actions/workflows/build.yml">here</a>. </sup>
 
 </div>
 
-###### Scope is in its earliest stages of development. This readme will be fleshed out as the project progresses
+###### Scope is in its earliest stages of development. This README will be fleshed out as the project progresses.
 
-## Building
+## Building the Project
 
 ### Prerequisites
 
@@ -33,14 +33,7 @@ The discord client for power users.
 2. Run `cargo build --release`
 3. The binary will be in `./target/release/scope`
 
-### Environment
-
-The binary presently requires the following environment variables to be set or in a `.env` file in the current working directory:
-
-- `DISCORD_TOKEN` - your discord token
-- `DEMO_CHANNEL_ID` - the channel ID to listen for messages on
-
-## Developing
+## Development Setup
 
 ### Prerequisites
 
@@ -50,11 +43,11 @@ The binary presently requires the following environment variables to be set or i
 
 1. Clone the repository
 2. Run `cargo run`
-   - It's reccomended to use `cargo watch -- cargo run` from [cargo-watch](https://github.com/watchexec/cargo-watch), but it's in no way required
+   - It's recommended to use `cargo watch -- cargo run` from [cargo-watch](https://github.com/watchexec/cargo-watch), but it's optional
 
-### Environment
+## Environment Variables
 
-The binary presently requires the following environment variables to be set or in a `.env` file in the current working directory:
+The binary requires the following environment variables to be set in the current working directory or in a `.env` file:
 
-- `DISCORD_TOKEN` - your discord token
-- `DEMO_CHANNEL_ID` - the channel ID to listen for messages on
+- `DISCORD_TOKEN` - Your Discord token
+- `DEMO_CHANNEL_ID` - The channel ID to listen for messages on