Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aljawaid committed Nov 22, 2022
1 parent a03e4aa commit 8da7f4c
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,13 @@ Screenshots

![Screenshot Name](../master/screenshot-name.png "Read Screenshot Name")


Usage
-------------

Go to `Settings` ⥂


Compatibility
-------------

Expand All @@ -35,6 +37,7 @@ Compatibility
- `01` Template override
- _No database changes_


Changelog
---------

Expand All @@ -53,21 +56,21 @@ Installation
**_or_**

- **Install via the [Releases](../master/Releases/ "A copy of each release is saved in the folder") folder**
- A copy of each release is saved in the `/Releases` folder of the repository
- Simply extract the `.zip` file into the `/plugins` directory
- A copy of each release is saved in the `/Releases` folder of the repository
- Simply extract the `.zip` file into the `/plugins` directory

**_or_**

- **Install via [GitHub](https://github.com/url "Find the correct plugin from the list of repositories")**
- Download the `.zip` file and decompress everything under the directory `/plugins`
- The folder inside the `.zip` must not contain any branch names and must be exact case (matching the plugin name)
- Download the `.zip` file and decompress everything under the directory `/plugins`
- The folder inside the `.zip` must not contain any branch names and must be exact case (matching the plugin name)

_Note: The `/plugins` folder is case-sensitive._

**_or_**

- **Install using Git CLI**
- `git clone` (_or ftp upload_) and extract the `.zip` file into this folder: `.\plugins\` (must be exact case)
- `git clone` (_or ftp upload_) and extract the `.zip` file into this folder: `.\plugins\` (must be exact case)


Translations
Expand All @@ -83,6 +86,7 @@ Authors & Contributors
- [name](https://github.com/url) - Author
- _Contributors welcome_


License
-------
- This project is distributed under the [MIT License](../master/LICENSE "Read The MIT license")

0 comments on commit 8da7f4c

Please sign in to comment.