From 188884062919322fe6d47c3f943205361eacc6de Mon Sep 17 00:00:00 2001 From: Andrew Zambazos Date: Sat, 26 Jul 2025 13:21:47 +1200 Subject: [PATCH] Update README.md --- README.md | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 63 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d5be8bd..724ee01 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,64 @@ -# NebulaBrowser +# Nebula + +![Nebula Logo](assets/images/Logos/Nebula-Logo.svg) + +A customizable and privacy-focused web browser built with Electron. + +## Features + +* **Custom Theming:** Personalize your browsing experience with custom themes. +* **Privacy Control:** Easily clear your browsing data, including history, cookies, and cache. +* **Tab Management:** Open new tabs, and manage them efficiently. +* **History:** Keeps track of your browsing and search history. +* **Bookmarks:** Save your favorite sites. +* **Custom Start Page:** Set your own home page. +* **Zoom Controls:** Adjust the zoom level of pages. + +## Getting Started + +### Prerequisites + +* [Node.js](https://nodejs.org/) installed. + +### Installation + +1. Clone the repository: + ```sh + git clone https://github.com/Bobbybear007/NebulaBrowser.git + ``` +2. Navigate to the project directory: + ```sh + cd NebulaBrowser + ``` +3. Install dependencies: + ```sh + npm install + ``` + +### Running the Application + +To start the browser, run the following command: + +```sh +npm start +``` + +## Building the Application + +To build the application for your platform, run: + +```sh +npm run dist +``` + +This will create a distributable file in the `dist` directory. + +## Technologies Used + +* [Electron](https://www.electronjs.org/) +* HTML, CSS, JavaScript + +## License + +This project is licensed under the ISC License.