Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
WirelessAlien authored Jan 5, 2025
1 parent 813a87e commit cca0b05
Showing 1 changed file with 61 additions and 15 deletions.
76 changes: 61 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,36 @@
![IzzyOnDroid](https://img.shields.io/endpoint?url=https://apt.izzysoft.de/fdroid/api/v1/shield/com.wirelessalien.zipxtract)
[![F-Droid](https://img.shields.io/f-droid/v/com.wirelessalien.zipxtract?logo=F-Droid)](https://f-droid.org/packages/com.wirelessalien.zipxtract)

It can extract rar, zip, tar, bz2, gz, 7z, jar, z & xz etc.
ZipXtract is a fully open-source Android application designed to handle a wide range of archive formats, including:

- [x] Added the method to Extract password protected Zip, 7z
* RAR (with RAR5 and multi-volume support)
* ZIP (including password-protected and split archives)
* TAR
* BZ2
* GZ
* 7z (with password protection and multi-volume support)
* XZ
* JAR
* ...

- [x] Added zip & 7z creation ability (encrypted & non encrypted)
## Features

- [x] Added extraction support for RAR (RAR5 supported) with multi-volume
### Extraction:

- [x] Added extraction support for Split Zip
* Supports various formats: RAR, ZIP, TAR, BZ2, GZ, 7z, XZ, JAR etc.
* Handles encrypted ZIP and 7z files.
* Extracts multi-volume RAR archives.
* Extracts multi-volume archives.
* Extracts split ZIP files.

- [x] Added Split Zip creation ability
### Creation:

* Create ZIP and 7z archives, with options for encryption.
* Create split ZIP archives.

- [ ] Multi-volume 7z extraction ability will be added.
## Installation

#### I am currently rewriting the app's source code. A new version will be released shortly.

### Contribution

* Contributions are greatly appreciated.
You can download and install ZipXtract from the following sources:

[<img src="https://github.com/WirelessAlien/ZipXtract/assets/121420261/3857dcf6-8560-4b1a-bfcd-0e12afa18b95"
alt="Get it on GitHub"
Expand All @@ -38,18 +48,54 @@ It can extract rar, zip, tar, bz2, gz, 7z, jar, z & xz etc.
alt="Get it on F-Droid"
height="80">](https://f-droid.org/en/packages/com.wirelessalien.zipxtract/)

> [!NOTE]
>The F-Droid version does not include RAR extraction and 7z compression features due to licensing restrictions. For the complete version, please use the GitHub or IzzyOnDroid releases.
## Usage tip

General tips for archive extraction and archive creation:

* Long-press files and folders or click file/folder icons to select them for archiving.

* Click a file to display the extraction menu for choosing extraction options.

* Files extracted using "Open With" menu of OS are stored in Internal Storage/ZipXtract by default. Modify this in app settings.

* The default location for archiving or extracting archives (within the app) is the parent directory of the respective file(s). This can be changed in the app settings.

## App permission

Read and Write Storage Permission (Android 10 and below) and Manage External Storage Permission (Android 11 and above). The app does not have internet permission. Read more - [Privacy policy](https://sites.google.com/view/privacy-policy-zipxtract/home)

### RAR extraction and 7z compression feature not available in F-Droid version of the app
### Complete version is available on IzzyOnDroid and Github Release
## Contributing

Contributions are greatly appreciated! To contribute:

1. Fork the repository.
2. Create a new branch (`git checkout -b feature/YourFeature`).
3. Commit your changes (`git commit -m 'Add some feature'`).
4. Push to the branch (`git push origin feature/YourFeature`).
5. Open a Pull Request.

### Translate

<a href="https://hosted.weblate.org/engage/zipxtract/">
<img src="https://hosted.weblate.org/widget/zipxtract/translate/multi-auto.svg" alt="Translation status" />
</a>

### Donate
## License

This project is licensed under the GNU General Public License v3.0. See the [LICENSE](https://github.com/WirelessAlien/ZipXtract/blob/master/LICENSE) file for details.

## Acknowledgements

The app icon vector by <a href="https://www.figma.com/community/file/1166831539721848736?ref=svgrepo.com" target="_blank">Solar Icons</a> in CC Attribution License via <a href="https://www.svgrepo.com/" target="_blank">SVG Repo</a>

## Contact

For any inquiries or feedback, please open an issue on the [GitHub repository](https://github.com/WirelessAlien/ZipXtract/issues).

## Donate

<noscript><a href="https://liberapay.com/WirelessAlien/donate"><img alt="Donate using Liberapay" src="https://liberapay.com/assets/widgets/donate.svg"></a></noscript>

Expand Down

0 comments on commit cca0b05

Please sign in to comment.