Skip to content

Commit

Permalink
docs: update instructions
Browse files Browse the repository at this point in the history
- Add dev & build for firefox
- Rephraze some sentences
  • Loading branch information
amasin76 committed Apr 9, 2024
1 parent 53e5bb3 commit 38d2ae4
Showing 1 changed file with 58 additions and 21 deletions.
79 changes: 58 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# 💫 ALX Intranet Extension 💫
<p align="center"> <a rel="noreferrer noopener" target="_blank" href="https://chrome.google.com/webstore/detail/alx-intranet/eagnmhadjdelkimfjbelmndejpepgmef/"><img alt="Chrome Web Store" src="https://img.shields.io/badge/Chrome-141e24.svg?&style=for-the-badge&logo=google-chrome&logoColor=white"></a></p>

<p align="center"> <a rel="noreferrer noopener" target="_blank" href="https://chromewebstore.google.com/detail/alx-intranet/eagnmhadjdelkimfjbelmndejpepgmef"><img alt="Chrome Web Store" src="https://img.shields.io/badge/Chrome-203424.svg?&style=for-the-badge&logo=google-chrome&logoColor=white"></a></p>
<p>
<div align="center"> <img src="https://i.imgur.com/8hmgGKr.png" alt="Preview" height="400" width="250"> </div>
<p align="center"><sub>(Screenshot from v0.2.2)</sub></p> <br />
<img height="32" width="32" src="https://cdn.simpleicons.org/youtube"/>
<a rel="noreferrer noopener" target="_blank" href="https://youtu.be/6FhrEXUd1m4"> Tutorial Video</a> By <a rel="noreferrer noopener" target="_blank" href="https://github.com/nuuxcode">Mounssif</a> ❤️
<p><a rel="noreferrer noopener" target="_blank" href="https://youtu.be/6FhrEXUd1m4"> Tutorial Video</a> By <a rel="noreferrer noopener" target="_blank" href="https://github.com/nuuxcode">Mounssif</a> ❤️</p>

## 🎛️ Features

Expand Down Expand Up @@ -33,35 +34,71 @@ fully customize the styling of your intranet page

There are several ways to install the extension:

- **Chrome Web Store**: You can install the extension directly from the <a rel="noreferrer noopener" target="_blank" href="https://chrome.google.com/webstore/detail/alx-intranet/eagnmhadjdelkimfjbelmndejpepgmef">Chrome Web Store</a>. Updates may be delayed by ~2 days due to the store review process.
- **Release Assets**: You can download the ZIP file from the <a rel="noreferrer noopener" target="_blank" href="https://github.com/amasin76/intranet-web-extension/releases">Release Assets</a> and extract it to a folder on your computer. Then,
- Open your browser and navigate to the extensions page (`chrome://extensions` for Chrome or `edge://extensions` for Edge).
- Enable developer mode by toggling the switch in the top right corner of the extensions page.
- Click on the Load unpacked button and select the folder where you extracted the extension files.
- The extension should now be installed and ready to use!
- **Build from Source**: Requires Node.js >16.6 or >18 and either `yarn` (recommended) or `npm`. Run `yarn install` followed by `yarn build`. After, you will have a `dist` folder. Follow the previous instructions in the "Release Assets" to install the extension from the `dist` folder.
- **Web Stores**: For chromium-based browsers <a rel="noreferrer noopener" target="_blank" href="https://chromewebstore.google.com/detail/alx-intranet/eagnmhadjdelkimfjbelmndejpepgmef">Chrome Web Store</a>.

- **Release Assets**: Download the ZIP file from the <a rel="noreferrer noopener" target="_blank" href="https://github.com/amasin76/intranet-web-extension/releases">Release Assets</a> and extract it to a folder. Then,
1- Navigate to the dev extension page (Chrome `chrome://extensions`, Edge `edge://extensions`,
Firefox `about:debugging#/runtime/this-firefox`).
2- Enable developer mode by toggling the switch in the top right corner of the extensions page.
3- Click on the `Load Unpacked`, in Firefox click `Load Temporary Add-on`.
4- Select the folder where you extracted the extension files.
5- The extension should now be installed and ready to use!
- **Build from Source**: check following [section](#🔧-dev-and-build) to build the extension. After, you will have a `dist` folder. Follow the previous instructions in the "Release Assets" start from step 1 to install the extension from the `dist` folder.

## 🔧 Dev and Build

> [!NOTE]
> Requires nodeJs v18 or higher, install `pnpm` (recommended)
### Chrome

- run in dev mode

```sh
pnpm dev
```

- build the extension

## ⚙️ Usage
```sh
pnpm build
```

### Firefox

- run in dev mode

```sh
pnpm dev:firefox
```

- build the extension

```sh
pnpm build:firefox
```

## 🧭 Usage

- **Initial Files and Directories:**
Click `[Tasks]` button, and paste the command in your terminal, then click Enter
- **Task Navigation:**
Press the number keys on your keyboard to navigate to the corresponding task.
For example, pressing the 1 key will scroll the page to task 1.<br />
To navigate to a task with a two-digit number, hold down the Shift key while pressing the number keys.
For example, to navigate to task number 12, hold down the Shift key and press the 1 key followed by the 2 key.
- **Task Navigation:**
- `[0-9]` Press the number keys on your keyboard to navigate to the corresponding task.
- `Shift + [0-9] + [0-9]` task with a two-digit number, hold down the Shift while pressing number keys.
Example task 13 => "Shift + 1 + 3"
- `ctrl + k` toggle search bar
- **Checker Control**, **Easy Quiz**, **Collapse Tasks:**
The user interface is simple and self-explanatory
- **User Style:**
Go to extension settings ( click the top-right icon in popup )
Go to extension settings ( click the top-right icon ⚙️ in popup )

## 🛡️ Privacy and Policies

### Privacy

- Our extension is designed to be offline-first, meaning that it does not rely on any external servers or backdoors.

- We do not collect any personal data from our users. The only data we have access to is provided by Google Analytics, which shows us information such as the number of installs and uninstalls.
- We do not collect any personal data from our users. The only data we have access to is provided by the web store, which shows us information such as the number of installs and uninstalls.

### Policies

Expand All @@ -71,7 +108,6 @@ There are several ways to install the extension:

We are committed to providing a safe and enjoyable experience for all users.


## ❤️ Contributing

As an open-source project, contributions are welcome and appreciated! If you would like to contribute, please kindly follow these steps:
Expand All @@ -86,7 +122,8 @@ As an open-source project, contributions are welcome and appreciated! If you wou
If you have any questions or need help with the contribution process, feel free to open an issue on the project’s GitHub repository or Discord: Bio#2408

## 🚀 Feedback
Report a bug ➡️ <a rel="noreferrer noopener" target="_blank" href="https://github.com/amasin76/intranet-web-extension/issues/new/choose">GitHub Issue > Bug Report.</a>

Report a bug ➡️ <a rel="noreferrer noopener" target="_blank" href="https://github.com/amasin76/intranet-web-extension/issues/new/choose">GitHub Issue > Bug Report.</a>
Request a feature ➡️ <a rel="noreferrer noopener" target="_blank" href="https://github.com/amasin76/intranet-web-extension/issues/new/choose">GitHub Issue > Feature Request.</a>
Chit Chat ➡️ <a rel="noreferrer noopener" target="_blank" href="https://discord.gg/H3SYN7yanW">Discord Server</a>
Form ➡️ <a rel="noreferrer noopener" target="_blank" href="https://forms.gle/BLn5yXcwQeK8aKgu5">Google forms</a>
Chit Chat ➡️ <a rel="noreferrer noopener" target="_blank" href="https://discord.gg/H3SYN7yanW">Discord Server</a>
Form ➡️ <a rel="noreferrer noopener" target="_blank" href="https://forms.gle/BLn5yXcwQeK8aKgu5">Google forms</a>

0 comments on commit 38d2ae4

Please sign in to comment.