diff --git a/README.md b/README.md index c74f89ad..8ca32f0a 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,13 @@ -# DioHub for Github +

+ +
+ DioHub +

+

An open-source unofficial GitHub mobile client, that aims to deliver the ultimate GitHub experience on mobile devices. - - * [Summary](#summary) - * [Features](#features) - * [Roadmap](#roadmap) - * [Support](#support) - * [Screenshots](#screenshots) - * [Build Instructions](#build-instructions) - +It is under active development and aims to implement all the available features on the GitHub website, and much more.

-## Summary - -DioHub is an open-source unofficial GitHub mobile client, that aims to deliver the ultimate GitHub experience on mobile devices. - -It is under active development and aims to implement all the available features on the GitHub website, and much more. - - + [Alternatively, download the latest apk from releases](https://github.com/NamanShergill/diohub/releases) @@ -43,35 +35,22 @@ It is under active development and aims to implement all the available features - Caching for partial offline support ---- +
+ Screenshots + + + + + +
-## Roadmap -- [Features Roadmap here](https://github.com/NamanShergill/diohub/issues/41) -- Readme that delves deeper into the application and its features. +--- +[Roadmap](https://github.com/NamanShergill/diohub/issues/41) -## Support +More info can be found in the [wiki](https://github.com/lasersPew/diohub/wiki) -[Like this project? Click here if you would like to support its development!](https://www.buymeacoffee.com/byefelixia) - -## Screenshots -![Screenshot_20210806-230536408](https://user-images.githubusercontent.com/33877135/129139265-79be2054-e146-4198-b548-3a42f7e07967.jpg) -![Screenshot_20210806-230547276](https://user-images.githubusercontent.com/33877135/129139267-8473fda5-a780-47a2-b875-99426f429829.jpg) -![Screenshot_20210806-230607898](https://user-images.githubusercontent.com/33877135/129139268-5498be91-d845-4ad7-b5ba-e97fb976e5c6.jpg) -![Screenshot_20210806-230622659](https://user-images.githubusercontent.com/33877135/129139269-2e658867-549d-4bd2-8b12-ffbeeda6d680.jpg) -![Screenshot_20210806-231053046](https://user-images.githubusercontent.com/33877135/129139271-6505e352-ad9d-49be-aeaf-c168f9b4f435.jpg) - -## Build Instructions +--- -- [Install Flutter on your system.](https://flutter.dev/docs/get-started/install) -- [Create a GitHub OAuth application.](https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app) - - Set the `Authorization callback URL` to `auth.felix.diohub://login-callback`. -- Create a file under `lib\app` named `keys.dart` with the following content: - ```dart - class PrivateKeys { - static const clientID = ''; - static const clientSecret = ''; - } - ``` -- Run `flutter pub get` and build the project. +Like this project? Click here to support it: -This readme is just an initial draft so apologies for it not being as comprehensive. +[![Buy Me a Coffee](assets/bmac.svg)](https://www.buymeacoffee.com/byefelixia) \ No newline at end of file diff --git a/assets/bmac.svg b/assets/bmac.svg new file mode 100644 index 00000000..ef9943ea --- /dev/null +++ b/assets/bmac.svg @@ -0,0 +1,22 @@ + + + + + + + + + + + + + + + + + + + + + +