Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
clearfeld authored Jul 4, 2023
1 parent 8b2304b commit bcc8908
Showing 1 changed file with 26 additions and 12 deletions.
38 changes: 26 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,43 @@
# aspis
# Aspis

A new Flutter project.
Aspis is a free, secure, and open source 2FA app targeting all major platforms, check the table below for current platform support.

## Getting Started
| Android | iOS | Windows | MacOS | Linux | Web |
|--------------------|-----------|---------------------|---------------------|---------------------|-----|
| :heavy_check_mark: | Planned | :heavy_check_mark:* | :heavy_check_mark:* | :heavy_check_mark:* | ✖️ |

This project is a starting point for a Flutter application.
## Screenshots

A few resources to get you started if this is your first Flutter project:
<img src="https://user-images.githubusercontent.com/49600278/250694714-83e20662-140b-4d51-a7f0-4f643a3ee7aa.png"
alt="Screenshot-1-Dark" width="200"/>
<img src="https://user-images.githubusercontent.com/49600278/250694717-33f4f1ca-3fd8-4b36-b1d5-7883f345c80c.png"
alt="Screenshot-2-Dark" width="200"/>
<img src="https://user-images.githubusercontent.com/49600278/250694716-253c8dba-b602-4a0a-87b6-f465a5f6ca04.png"
alt="Screenshot-1-Light" width="200"/>
<img src="https://user-images.githubusercontent.com/49600278/250694715-88c68469-5bfb-45a3-bd07-d860af8a8631.png"
alt="Screenshot-2-Light" width="200"/>

- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
## Features

For help getting started with Flutter development, view the
[online documentation](https://docs.flutter.dev/), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
* Free and open source
* Secure
* Password required (Encrypted realm db vault)
* Supports HTOP and TOTP codes
* Add QR Codes
* Scan QR codes (mobile systems only)
* Manual entry
* Dark and light themes

## Realm
## Getting Started
### Realm

Must run the following command, when new realm models are added or modified.

```bash
flutter pub run realm generate
```

## i18n
### i18n

Must run the following command, when new translations are added.

Expand Down

0 comments on commit bcc8908

Please sign in to comment.