Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Konloch authored Jul 16, 2023
1 parent 8d6e901 commit 23a632f
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# DiskLib
DiskLib is an easy-to-use zero dependency Disk Writer & Disk Reader with built-in GZIP support for Java.

## How To Add As Library
## 💡 Requirements
+ Java Runtime 1.8 **or higher**

## ⚙️ How To Add As Library
Add it as a maven dependency or just [download the latest release](https://github.com/Konloch/DiskLib/releases).
```xml
<dependency>
Expand All @@ -11,19 +14,19 @@ Add it as a maven dependency or just [download the latest release](https://githu
</dependency>
```

## Links
## 👨‍💻 Links
* [Website](https://konloch.com/DiskLib/)
* [Discord Server](https://discord.gg/aexsYpfMEf)
* [Download Releases](https://github.com/Konloch/DiskLib/releases)

## How To Use
## 💻 How To Use
**You can pass *either* a String path or a File object for the first parameter. To use the GZIP functionality, use GZIPDiskReader or GZIPDiskWriter**

### For more examples
[View the test file here](https://github.com/Konloch/DiskLib/blob/main/src/test/java/com/konloch/DiskLibTest.java), it has examples of each function being used.


## Reading
## ⬆️ Reading
### Reading Strings from disk
```java
ArrayList<String> lines = DiskReader.read("hello.txt");
Expand All @@ -39,7 +42,7 @@ String[] lines = DiskReader.readLines("hello.txt");
byte[] bytes = DiskReader.readBytes("hello.txt");
```

## Writing
## ⬇️ Writing
+ You can write / append `Lists`, or `Sets`, just pass where the string parameter goes for the content line.

### Write new file to disk / overwrite existing file
Expand Down

0 comments on commit 23a632f

Please sign in to comment.