Skip to content

Commit 76df7a6

Browse files
authored
Update README.md
1 parent 9f4aa63 commit 76df7a6

File tree

1 file changed

+48
-1
lines changed

1 file changed

+48
-1
lines changed

README.md

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,56 @@ Advanced authentication system, unlimited & free to use!
33

44
[![Stability: Experimental](https://masterminds.github.io/stability/experimental.svg)](https://masterminds.github.io/stability/experimental.html)
55

6-
# Introduction:
6+
# Some information:
77
I made this authentication system for one of my programs, I decided to release it as a library but, this project is undone yet!
88

9+
If you found some bug that you would like it to be fixed or just give suggestion open an issue on the Issues tab.
10+
11+
I think this library is better than the paid authentication systems because FireBase is pretty fast and I tried to keep the code as much optimized as I can (for better performance).
12+
13+
Have fun 😝
14+
15+
# Features:
16+
* Supports Discord webhook integration.
17+
* Auto-update system.
18+
* Killswitch.
19+
* Blacklist system.
20+
* Some state functions.
21+
* And some general functions such as Login, Register, Create License.
22+
23+
# Plans:
24+
* Add more optimization.
25+
* Easier use.
26+
* Documentation.
27+
* Explain what everything stands for.
28+
* Upload the auto-update system (it's already ready but I'm lazy to upload).
29+
30+
# Getting started:
31+
If you don't have a FireBase account you will need to create one.
32+
33+
It will be much easier learning the FireBase interface by yourself or watching some tutorials on FireBase.
34+
35+
After you have a FireBase account and you are connected, create a project and then create a "Realtime Database".
36+
Go to Project Settings -> Service Account -> Database Secrets and copy the key that is listed there.
37+
38+
```
39+
//Creating the credentials
40+
Credentials credentials = new Credentials()
41+
{
42+
//The current version of this distribution, Should look like: "0.0.0"
43+
Version = Version.Parse("1.0.0"),
44+
45+
//The base address of the database, Should look like (Depends on the country you have chose): "https://test-b572d-default-rtdb.europe-west1.firebasedatabase.app/"
46+
BaseAddress = "",
47+
48+
//The database secret you have copied before, Should look like: "4RLlgzCxDQ62JmJMzfFpLFruqKfPHmZUFJq4rya4"
49+
Token = ""
50+
};
51+
52+
AuthSystem auth = new AuthSystem(credentials);
53+
54+
//Now you can use the functions of the auth system, I will create short documentation later.
55+
```
956

1057
# LEGAL DISCLAIMER
1158

0 commit comments

Comments
 (0)