diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index d6b59e4..09f9539 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -13,7 +13,7 @@ jobs:
runs-on: ${{ matrix.os }}
strategy:
matrix:
- os: [ubuntu-latest, windows-latest, macos-latest]
+ os: [ubuntu-latest, windows-latest]
permissions:
contents: write
@@ -34,12 +34,6 @@ jobs:
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- - name: Build Mac x64
- if: matrix.os == 'macos-latest'
- run: npx electron-builder --mac --x64
- env:
- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
- name: Upload Release
uses: softprops/action-gh-release@v1
with:
diff --git a/.gitignore b/.gitignore
index b584e3a..3bd55ca 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,4 @@
node_modules
dist
-test
\ No newline at end of file
+test
+.idea
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c8a9791
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+
WebBox
+
+---
+
+
+
+WebBox is an interactive code editor focused on web development, providing live window updates.
+
+---
+
+* [Create a File](./docs/CreateFile.md)
+* [Open a File](./docs/OpenFile.md)
+* [Save a File](./docs/SaveFile.md)
+* [Viewer Windows](./docs/ViewerWindows.md)
+* [Shortcuts](./docs/Shortcuts.md)
+* [Customize Colors](./docs/CustomColors.md)
+
+---
+
+Developed as a school project by **Ethan Mahlstedt**
+
+---
+
+Want to help? Send me a [mail](mailto:ethan.mahlstedt@hotmail.com)
+
+---
+
Last modified at 13/05/25 by Ethan Mahlstedt; v1.0.0-rc2
\ No newline at end of file
diff --git a/docs/CreateFile.md b/docs/CreateFile.md
new file mode 100644
index 0000000..37cf08a
--- /dev/null
+++ b/docs/CreateFile.md
@@ -0,0 +1,28 @@
+###### Go back to [index](../README.md)
+
+---
+
+# Create File
+
+### Shortcut `Ctrl + N`
+
+---
+
+WebBox can create files using the built-in file creation function. The **"Create File"** function is capable of creating files based of presets saved on the `filePresets` folder.
+
+
+
+
+
+---
+
+Filename **must** include extension.
+
+---
+
+
+Filename and folder **are mandatory**.
+
+---
+
+
Last modified at 12/05/25 by Ethan Mahlstedt; v1.0-rc1
\ No newline at end of file
diff --git a/docs/CustomColors.md b/docs/CustomColors.md
new file mode 100644
index 0000000..52ce308
--- /dev/null
+++ b/docs/CustomColors.md
@@ -0,0 +1,17 @@
+###### Go back to [index](../README.md)
+
+---
+
+# Use custom colors
+
+---
+
+If you want to use custom colors, you must edit the files located at `editor/front`.
+
+`editor.css` includes all the editor window color configuration.
+
+`highlighter.css` includes the highlighter color configuration in [highlight.js](https://highlightjs.org/) syntax
+
+---
+
+
Last modified at 14/05/25 by Ethan Mahlstedt; v1.0-rc2
\ No newline at end of file
diff --git a/docs/OpenFile.md b/docs/OpenFile.md
new file mode 100644
index 0000000..29d1d4b
--- /dev/null
+++ b/docs/OpenFile.md
@@ -0,0 +1,27 @@
+###### Go back to [index](../README.md)
+
+---
+
+# Open File
+
+### Shortcut `Ctrl + O`
+
+---
+
+To open files, WebBox will prompt you to choose a file that matches the following file types:
+
+* **HTML** (.html, .htm)
+* **JavaScript** (.js, .jsx, .mjs, .cjs)
+* **TypeScript** (.ts, .tsx)
+* **CSS** (.css)
+* **JSON** (.JSON)
+* **Markdown** (.md)
+* **PHP** (.php)
+* **Text Documents** (.txt)
+* **XML** (.xml)
+
+
+
+---
+
+
Last modified at 14/05/25 by Ethan Mahlstedt; v1.0-rc2
\ No newline at end of file
diff --git a/docs/SaveFile.md b/docs/SaveFile.md
new file mode 100644
index 0000000..20ae6f6
--- /dev/null
+++ b/docs/SaveFile.md
@@ -0,0 +1,20 @@
+
+###### Go back to [index](../README.md)
+
+---
+
+# Close File
+
+### Shortcut `Ctrl + Q`
+
+---
+
+When closing files, WebBox will prompt you to save the file if it has unsaved changes. You can choose to save the file or discard the changes.
+
+
+
+Whenever a file has unsaved changes, the file name will be displayed in *italic* in the tab bar. This is a visual indicator that the file has unsaved changes.
+
+---
+
+
Last modified at 14/05/25 by Ethan Mahlstedt; v1.0-rc2
\ No newline at end of file
diff --git a/docs/Shortcuts.md b/docs/Shortcuts.md
new file mode 100644
index 0000000..54e69eb
--- /dev/null
+++ b/docs/Shortcuts.md
@@ -0,0 +1,23 @@
+###### Go back to [index](../README.md)
+
+---
+
+# Shortcuts
+
+---
+
+## Shortcut list
+
+| Shortcut | Action |
+|--------------------|-------------------------------------|
+| `Ctrl + N` | Create File |
+| `Ctrl + O` | Open File |
+| `Ctrl + S` | Save File |
+| `Ctrl + Q` | Close File |
+| `Ctrl + W` | Open Viewer |
+| `Ctrl + Shift + W` | Open Viewer (based on current file) |
+| `Ctrl + R` | Refresh Viewer |
+
+---
+
+
Last modified at 14/05/25 by Ethan Mahlstedt; v1.0-rc2
\ No newline at end of file
diff --git a/docs/ViewerWindows.md b/docs/ViewerWindows.md
new file mode 100644
index 0000000..6b4b35d
--- /dev/null
+++ b/docs/ViewerWindows.md
@@ -0,0 +1,22 @@
+
+###### Go back to [index](../README.md)
+
+---
+
+# Viewer Windows
+
+---
+
+WebBox has a built-in viewer that allows you to visualize HTML files on a separate window.
+
+The viewer is based of a Chromium browser window, which means that it is capable of using all the features of a modern browser. This includes the ability to use JavaScript and CSS files.
+
+To open the viewer, you can use the **"Open Viewer"** function in the file menu or use the shortcut `Ctrl + W`. If you press the `Shift` Key, the viewer will open a new window off the current opened file (in the case it is a `.html` / `.htm` file), linking the viewer to the file. If not, the viewer will prompt you to pick a valid file type.
+
+In the case you want to refresh the viewer, you can use the **"Refresh Viewer"** function in the file menu or use the shortcut `Ctrl + R`. This will refresh the current opened file in the viewer. In case the current file is not linked to any window, a prompt will show up, showing you all windows.
+
+
+
+---
+
+
Last modified at 14/05/25 by Ethan Mahlstedt; v1.0-rc2