Skip to content

Commit cff305d

Browse files
upd: README
1 parent b54e2c6 commit cff305d

File tree

1 file changed

+25
-27
lines changed

1 file changed

+25
-27
lines changed

README.md

Lines changed: 25 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This library is built based on the codes from [SharpCompress](https://github.com
1313

1414

1515

16-
# Sample
16+
# Usage
1717

1818
<details lang="ja">
1919
<summary><small>日本語</small></summary>
@@ -63,6 +63,30 @@ public class Sample
6363

6464

6565

66+
# Unity Installation
67+
68+
Add the following git URL to Unity Package Manager (UPM)
69+
70+
- Lastest: `https://github.com/sator-imaging/CSharp-TarArchiver.git`
71+
- v2.0.0: `https://github.com/sator-imaging/CSharp-TarArchiver.git#v2.0.0`
72+
73+
74+
Note that `src/Tests.cs` will add menu to Unity Editor that shows dialog for exporting test file.
75+
76+
![](https://dl.dropbox.com/s/5qkzw1j4a0ony5a/CSharp-TarArchiver.png)
77+
78+
79+
80+
# Features
81+
82+
- ✅ Creating TAR archive from `string`, `byte[]` or `Stream`
83+
- ⬜️ Creating TAR archive from local files or directory structure
84+
- ⬜️ Appending/Removing files in existing TAR archive
85+
- ⬜️ Reading TAR archive contents
86+
- ⬜️ Extracting files from TAR archive
87+
88+
89+
6690
# Copyright
6791

6892
Copyright &copy; 2023 Sator Imaging, all rights reserved.
@@ -139,29 +163,3 @@ THE SOFTWARE.
139163

140164
</details>
141165
</p>
142-
143-
144-
145-
# Features
146-
147-
- ✅ Creating TAR archive from `string`, `byte[]` or `Stream`
148-
- ⬜️ Creating TAR archive from local files or directory structure
149-
- ⬜️ Appending/Removing files in existing TAR archive
150-
- ⬜️ Reading TAR archive contents
151-
- ⬜️ Extracting files from TAR archive
152-
153-
154-
155-
# Unity
156-
157-
Tested with Unity 2021.3.
158-
159-
Use the following git URL to import this library using Unity Package Manager (UPM)
160-
161-
- Lastest: `https://github.com/sator-imaging/CSharp-TarArchiver.git`
162-
- v1.0.0: `https://github.com/sator-imaging/CSharp-TarArchiver.git#v1.0.0`
163-
164-
165-
Note that `src/Tests.cs` will add menu to Unity Editor that shows dialog for exporting test file.
166-
167-
![](https://dl.dropbox.com/s/5qkzw1j4a0ony5a/CSharp-TarArchiver.png)

0 commit comments

Comments
 (0)