Skip to content

Commit

Permalink
changing readme
Browse files Browse the repository at this point in the history
  • Loading branch information
anar-shaim committed Jul 11, 2021
1 parent 3954742 commit f1eb805
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,25 @@
# Disk Uploader – File Uploading Tool for Dropbox and Yandex.Disk
# Disk Uploader – File Uploading Tool for Dropbox, Yandex.Disk, Cloud Mail.ru and Yandex Object Storage

Disk Uploader is a Java Tool. It is intended for working with different file storages. For now it can work with Yandex.Disk and Dropbox.
Disk Uploader is a Java Tool. Its main purpose is upload file in file storage. Disk Uploader can work with different file storages. For now it can work with Dropbox, Yandex.Disk, Cloud Mail.ru and Yandex Object Storage.

## Features

You can use Disk Uploader to upload files in your storage. Also, Disk Uploader is suitable for uploading database archives. Furthermore, you can set some parameters to specify lower and upper bounds for files that can be stored in your catalog.

Also, you can set a .xml file and receive emails every time when Disk Uploader sends files to your storage successfully or catches an error at this operation.
Also, you can set a DiskSettings.xml file and receive emails every time when Disk Uploader sends files to your storage successfully or catches an error at this operation.

You can run Disk Uploader from command line, for example:

java -jar DiskUploader-1.0-jar-with-dependencies.jar --td=TypeOfTheDisk --fu=path\\to\\file\\file_name.txt --cu=/NameOfCatalogOnDisk/ --at=YourAuthenticationToken --tr=TopRest --mr=MinRest,

where TypeOfTheDisk is YA or DB, MinRest is minimum number of files that can be store in catalog, TopRest is maximum number of files that can be stored in catalog. Use only latin letters in --fu, --cu parameters.

To work with Cloud Mail.ru, you should specify parameters --td=MRC, --un=YourUserName and --pw=YourPassword. To work with Yandex Object Storage, you should specify parameters --td=YOS, --kid=YourKeyID and --sac=YourSecretAccessKey.

Also, if you have spaces in your name of the file to upload, or in name of the catalog in storage, wrap it in apostrophes.

If you need to use Disk Uploader in Java project, you can add .jar file to your project and use the utility through DiskParameters class.

In addition, Disk Uploader is an utility that has these several features:
* upload file to catalog in storage;
* delete files when free space in storage is not enough;
Expand Down

0 comments on commit f1eb805

Please sign in to comment.