diff --git a/README.md b/README.md index 183225d4f..6a867c696 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![codecov](https://codecov.io/gh/adorsys/datasafe/branch/develop/graph/badge.svg)](https://codecov.io/gh/adorsys/datasafe) [![Maintainability](https://api.codeclimate.com/v1/badges/06ae7d4cafc3012cee85/maintainability)](https://codeclimate.com/github/adorsys/datasafe/maintainability) -# Datasafe: Secure, Encrypted and Versioned Data Storage Library +# Secure, Encrypted and Versioned Data Storage Library ## Overview Datasafe is a robust library tailored for developers and enterprises, offering encrypted and versioned data storage. It enhances the security of data-sensitive applications, making it ideal for mission-critical usage. @@ -21,7 +21,7 @@ Datasafe uses AES-GCM (and Chacha-Poly for large files) for encryption, with CMS - **Configurability**: Dagger2 for dependency injection and modular design. - **Storage Compatibility**: Tested with Amazon S3, Minio, CEPH, and local filesystems. - **User Privacy**: Encrypts both the document and its path in each user's private space. -- **Versioning Support**: Provides application layer versioning for systems lacking native support. +- **Versioning Support**: Provides application layer versioning for systems lacking native versioning support. ## Getting Started diff --git a/docs/readme/Demo.md b/docs/readme/Demo.md index d183aac0f..5ce58abc1 100644 --- a/docs/readme/Demo.md +++ b/docs/readme/Demo.md @@ -34,7 +34,7 @@ the default value when prompted. ``` -![new_profile](docs/demo/new_profile.gif) +![new_profile](../demo/new_profile.gif) **Note**: Instead of creating file with credentials you can provide credentials directly into terminal (this is less secure than having credentials file, but is fine for demo purposes): @@ -76,7 +76,7 @@ cat private/encrypted_file_name_from_above ``` -![encrypt_decrypt_file](docs/demo/encrypt_decrypt_file.gif) +![encrypt_decrypt_file](../demo/encrypt_decrypt_file.gif) ##### You can always list available actions in context: @@ -95,8 +95,8 @@ cat private/encrypted_file_name_from_above ``` -![list_actions](docs/demo/list_actions.gif) +![list_actions](../demo/list_actions.gif) ### REST API demo -[Here](datasafe-rest-impl/DEMO.md) you can find quick docker-based demo of project capabilities with +[Here](../../datasafe-rest-impl/DEMO.md) you can find quick docker-based demo of project capabilities with instructions of how to use it (REST-api based to show how to deploy as encryption server).