Skip to content

Commit

Permalink
Remove docs
Browse files Browse the repository at this point in the history
  • Loading branch information
raphasampaio committed Aug 23, 2024
1 parent c709335 commit ff2285a
Show file tree
Hide file tree
Showing 8 changed files with 31 additions and 83 deletions.
25 changes: 0 additions & 25 deletions .github/workflows/Documentation.yml

This file was deleted.

38 changes: 31 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
# SharedPreferences.jl

[![Documentation](https://img.shields.io/badge/docs-stable-blue.svg)](https://raphasampaio.github.io/SharedPreferences.jl/stable)
[![CI](https://github.com/raphasampaio/SharedPreferences.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/raphasampaio/SharedPreferences.jl/actions/workflows/CI.yml)
[![codecov](https://codecov.io/gh/raphasampaio/SharedPreferences.jl/graph/badge.svg?token=FPKzhDwSAB)](https://codecov.io/gh/raphasampaio/SharedPreferences.jl)
[![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)

## Introduction
SharedPreferences.jl is a Julia package that provies a persistent storage of simple data. Based on the popular Dart package, it supports asynchronous disk persistence, offering flexibility and ease of use for storing non-critical data.

SharedPreferences.jl is a Julia package that provides persistent storage for simple data types. Inspired by the widely-used Dart package, this library supports asynchronous disk persistence, offering a flexible and user-friendly solution for storing non-critical data securely.

## Features:

- Easy and consistent API for storing and retrieving data.
- Asynchronous disk storage with encryption options for enhanced data security.
- Designed for storing preferences, settings, and lightweight non-critical data.

## Getting Started

Expand All @@ -17,23 +23,41 @@ julia> ] add SharedPreferences
```

### Example

Below is a sample usage demonstrating how to securely store and retrieve different data types using SharedPreferences.jl:

```julia
using SharedPreferences

# encryption key for secure storage
key = "JjL9kX9BRNsHa6ykI8s8eV9ZX2Wb1Fsf"

# create an encrypted instance of SharedPreferences
instance = SharedPreferences.InstanceEncrypted(key)

# store data of various types
set!(instance, "string", "value")
set!(instance, "integer", 42)
set!(instance, "float", 3.14)
set!(instance, "boolean", true)
set!(instance, "array", [1, 2, 3])

# retrieve stored data
instance = SharedPreferences.InstanceEncrypted(key)
string = get(instance, "string")
integer = get(instance, "integer")
float = get(instance, "float")
boolean = get(instance, "boolean")
array = get(instance, "array")

stored_string = get(instance, "string")
stored_integer = get(instance, "integer")
stored_float = get(instance, "float")
stored_boolean = get(instance, "boolean")
stored_array = get(instance, "array")

println("Stored string: ", stored_string)
println("Stored integer: ", stored_integer)
println("Stored float: ", stored_float)
println("Stored boolean: ", stored_boolean)
println("Stored array: ", stored_array)
```

## Contributing

Contributions, bug reports, and feature requests are welcome! Feel free to open an issue or submit a pull request.
5 changes: 0 additions & 5 deletions docs/Project.toml

This file was deleted.

2 changes: 0 additions & 2 deletions docs/docs.bat

This file was deleted.

30 changes: 0 additions & 30 deletions docs/make.jl

This file was deleted.

Binary file removed docs/src/assets/favicon.ico
Binary file not shown.
6 changes: 0 additions & 6 deletions docs/src/assets/logo.svg

This file was deleted.

8 changes: 0 additions & 8 deletions docs/src/index.md

This file was deleted.

0 comments on commit ff2285a

Please sign in to comment.