From c701e4db2c36c358205d5f3693eacdb8b5948c57 Mon Sep 17 00:00:00 2001 From: William Brawner Date: Thu, 3 Nov 2022 08:35:47 -0600 Subject: [PATCH] Update README --- README.md | 31 +++++++++---------------------- 1 file changed, 9 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 93d3724..12b63b4 100644 --- a/README.md +++ b/README.md @@ -2,46 +2,33 @@ [![pipeline status](https://github.com/wbrawner/SimpleMarkdown/actions/workflows/android.yml/badge.svg)](https://github.com/wbrawner/SimpleMarkdown/actions/workflows/android.yml) -Simple Markdown is simply a Markdown editor :) I wrote it to offer up an open source alternative to -the other Markdown editors available on the Play Store. I also wanted to get some practice in -creating Android apps and have a little something to put into my portfolio. + + + + +Simple Markdown is an open source Markdown editor. + +Get it on Google Play [Get it on F-Droid](https://f-droid.org/packages/com.wbrawner.simplemarkdown.free/) -## Roadmap - -* [x] Auto-save -* [x] Night mode -* [x] Save to cloud (Dropbox, Google Drive, OneDrive) -* [x] Custom CSS for Markdown preview -* [ ] Better insert for tables/images/links -* [ ] Quick-insert toolbar for common Markdown syntax characters -* [ ] Auto-scroll preview to match edit view in landscape mode -* [ ] Disable live preview in landscape mode -* [ ] Disable preview tab for better performance in large files - ## Building Using Android Studio is the preferred way to build the project. To build from the command line, you can run - ./gradlew assembleDebug + ./gradlew assembleFreeDebug ### Crashlytics SimpleMarkdown makes use of Firebase Crashlytics for error reporting. You'll need to follow the [Get started with Firebase Crashlytics](https://firebase.google.com/docs/crashlytics/get-started?platform=android) guide in order to build the project. -## Contributing - -I'd love any contributions, particularly in improving the existing code. Please just fork the -repository, make your changes, squash your commits, and submit a pull request :) - ## License ``` - Copyright 2017-2019 William Brawner + Copyright 2017-2022 William Brawner Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.