Skip to content

Commit

Permalink
active development
Browse files Browse the repository at this point in the history
  • Loading branch information
Keshav Priyadarshi authored and Keshav Priyadarshi committed Jun 24, 2021
1 parent b54f39b commit 61d5ccc
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 10 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,6 @@ app.*.map.json

# Ignore Ios for now
/ios/

#Ignore Tem Devlopment File
README_copy.md
83 changes: 73 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,79 @@
# Safe Notes
<p align="center"><a href="https://safe-notes.keshav.space"><img src="assets/splash.png" width="150"></a></p>
<h2 align="center"><b>Safe Notes</b></h2>
<h4 align="center">A encrypted, private note keeper for Android.</h4>

A Heaven For Your Data.
<p align="center"><a href="f-droid url"><img src="assets/get-it-on-f-droid-badge.png" height='65px'></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="google play url"><img src="assets/get-it-on-google-play-badge.png" height='65px' ></a></p>

## Getting Started
<p align="center">
<a href="https://github.com/keshav-space/safe_notes/releases" alt="GitHub release"><img src="https://img.shields.io/github/v/release/keshav-space/safe_notes" ></a>
<a href="https://www.gnu.org/licenses/gpl-3.0" alt="License: GPLv3"><img src="https://img.shields.io/badge/License-GPL%20v3-blue.svg"></a>
<a href="https://github.com/keshav-space/safe_notes/actions/" alt="Build Status"><img src="https://github.com/keshav-space/safe_notes/actions/workflows/flutter-ci.yml/badge.svg"></a>
<a href="https://web.libera.chat/#newpipe" alt="IRC channel: #newpipe"><img src="https://img.shields.io/badge/IRC%20chat-%23newpipe-brightgreen.svg"></a>

This project is a starting point for a Flutter application.
</p>
<hr>
<p align="center"><a href="#screenshots">Screenshots</a> &bull; <a href="#description">Description</a> &bull; <a href="#features">Features</a> &bull; <a href="#installation-and-updates">Installation and updates</a> &bull; <a href="#contribution">Contribution</a> <!-- &bull; <a href="#donate">Donate</a> --> &bull; <a href="#license">License</a></p>
<p align="center"><a href="https://safe-notes.keshav.space">Website</a> &bull; <a href="https://safe-notes.keshav.space/blog/">Blog</a> &bull; <a href="https://safe-notes.keshav.space/FAQ/">FAQ</a> &bull; <a href="https://safe-notes.keshav.space/press/">Press</a></p>
<hr>

A few resources to get you started if this is your first Flutter project:

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

For help getting started with Flutter, view our
[online documentation](https://flutter.dev/docs), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
## Screenshots

[<img src="metadata/android/images/phoneScreenshots/shot_01.png" width=160>](metadata/android/images/phoneScreenshots/shot_01.png)
[<img src="metadata/android/images/phoneScreenshots/shot_02.png" width=160>](metadata/android/images/phoneScreenshots/shot_02.png)
[<img src="metadata/android/images/phoneScreenshots/shot_03.png" width=160>](metadata/android/images/phoneScreenshots/shot_03.png)
[<img src="metadata/android/images/phoneScreenshots/shot_04.png" width=160>](metadata/android/images/phoneScreenshots/shot_04.png)
[<img src="metadata/android/images/phoneScreenshots/shot_05.png" width=160>](metadata/android/images/phoneScreenshots/shot_05.png)
[<img src="metadata/android/images/phoneScreenshots/shot_06.png" width=160>](metadata/android/images/phoneScreenshots/shot_06.png)
[<img src="metadata/android/images/phoneScreenshots/shot_07.png" width=160>](metadata/android/images/phoneScreenshots/shot_07.png)
[<img src="metadata/android/images/phoneScreenshots/shot_08.png" width=160>](metadata/android/images/phoneScreenshots/shot_08.png)

<!-- [<img src="metadata/android/images/phoneScreenshots/shot_09.png" width=160>](metadata/android/images/phoneScreenshots/shot_09.png)
[<img src="metadata/android/images/phoneScreenshots/shot_10.png" width=160>](metadata/android/images/phoneScreenshots/shot_10.png)
[<img src="metadata/android/images/phoneScreenshots/shot_11.png" width=405>](metadata/android/images/phoneScreenshots/shot_11.png)
[<img src="metadata/android/images/phoneScreenshots/shot_12.png" width=405>](metadata/android/images/phoneScreenshots/shot_12.png) -->

## Description

Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.

### Features

* Encrypted AES-256 Storage
* Data export both encrypted and unencrypted
* Both encrypted and un-encrypted Import option
* Dark Theme/ Light Theme
* Easy migration to new device

<!-- Hidden span to keep old links compatible. -->
<span id="updates"></span>

## Installation and updates
You can install Safe Notes using one of the following methods:
1. Download Safe Notes from the Google Play store using this link.
2. Download Safe Notes from the F-Droid using this link.
3. Download the APK from [Github Releases](https://github.com/keshav-space/safe_notes) and install it.
4. Build a debug APK yourself. This is the fastest way to get new features on your device, but is much more complicated, so we recommend using one of the other methods.

We recommend method 1 or 2 for most users. APKs installed using method 1 or 3 are compatible with each other. Building a debug APK using method 4 excludes a key entirely. Signing keys help ensure that a user isn't tricked into installing a malicious update to an app.


## Contribution
Whether you have ideas, design changes, code cleaning, or real heavy code changes, help is always welcome.
The more is done the better it gets!

If you'd like to get involved, check our [contribution notes](.github/CONTRIBUTING.md).

## Privacy Policy

The Safe Notes project aims to provide a encrypted, private, anonymous experience for local note storage. The app doesn't send any outbound requests neither does it receives any inbound requests. Therefore, the app doesn't collect any data whatsoever. You can find the document [here](https://safe-notes.keshav.space/legal/privacy/).

## License
[![GNU GPLv3 Image](https://www.gnu.org/graphics/gplv3-127x51.png)](https://www.gnu.org/licenses/gpl-3.0.en.html)

Safe Notes is Free Software: You can use, study share and improve it at your
will. Specifically
[GNU General Public License](https://www.gnu.org/licenses/gpl.html) as
published by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

0 comments on commit 61d5ccc

Please sign in to comment.