FUH22860/OneForAll
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added readme.md

Browse Source 
Added a readme to make the repo a bit more friendly.
This commit is contained in:
FUH22860 2022-03-16 21:29:20 +01:00 committed by GitHub
parent 29f38ab9ab
commit d982be5b1c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 59 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
README.md Normal file
View File

@ -0,0 +1,59 @@
# OneForAll
> Licence management Software - Easy to use and Extensible
<img src="![image](https://user-images.githubusercontent.com/101731147/158679084-abd69aa5-78a3-4122-b443-1fa2a2d82325.png)" />
## 🚩 Table of Contents
- [Why TOAST UI Editor?](#-why-oneforall)
- [Browser Support](#-browser-support)
- [Pull Request Steps](#-pull-request-steps)
- [License](#-license)
## 🤖 Why OneForAll?
OneForAll provides an affordable way to manage licences for small or even large businesses.
### UI
* **Dark Theme** : A dark theme is in the works.
### Plugins
We are planning to bring plugin support in the future.
## 🎨 Features
* [Viewer](![image](https://user-images.githubusercontent.com/101731147/158681174-ea3bbf52-c300-453e-a915-737474b33cd2.png)) : View licence and edit with the clikc of a button.
* [Editor](![image](https://user-images.githubusercontent.com/101731147/158681512-c8839553-28e2-41d7-92e1-43a78b786bd4.png)) : Edit licence push the change to the server.
## 🌏 Browser Support
| <img src="https://user-images.githubusercontent.com/1215767/34348387-a2e64588-ea4d-11e7-8267-a43365103afe.png" alt="Chrome" width="16px" height="16px" /> Chrome | <img src="https://user-images.githubusercontent.com/1215767/34348380-93e77ae8-ea4d-11e7-8696-9a989ddbbbf5.png" alt="Edge" width="16px" height="16px" /> Edge | <img src="https://user-images.githubusercontent.com/1215767/34348383-9e7ed492-ea4d-11e7-910c-03b39d52f496.png" alt="Firefox" width="16px" height="16px" /> Firefox |
| :---------: | :---------: | :---------: |
| Yes | Yes | Yes |
## 🔧 Pull Request Steps
OneForAll is open source, so you can make a pull request(PR) to fix an issue.
### Setup
Fork `main` branch into your personal repository. Clone it to your local computer. Before starting development, you should check if there are any errors.
```sh
$ git clone https://github.com/{your-personal-repo}/OneForAll.git
```
### Pull Request
Before uploading your PR, run test one last time to check if there are any errors. If it has no errors, commit and then push it!
## 📜 License
This software is licensed under the [GNU GPLv3](https://github.com/FUH22860/OneForAll/LICENSE.md).