diff --git a/README.md b/README.md index d067a29..96a32b3 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,36 @@ -![Android CI](https://github.com/akaessens/NoFbEventScraper/workflows/Android%20CI/badge.svg) +[![Android CI](https://github.com/akaessens/NoFbEventScraper/workflows/Android%20CI/badge.svg)](https://github.com/akaessens/NoFbEventScraper/actions) +[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://github.com/akaessens/NoFbEventScraper/blob/master/LICENSE) +[![Release](https://img.shields.io/github/release/akaessens/nofbeventscraper.svg?logo=github)](https://github.com/akaessens/NoFbEventScraper/releases/latest) + + Feature Graphic -# NoFb Event Scraper +# Description -This application was developed to be used without a facebook account. +This application was developed to be used without a Facebook account. -Therefore it does not use the facebook API. -Instead it opens the facebook event URI and downloads the website source code. +Therefore it does not use the Facebook API. +Instead it opens the Facebook event URI and downloads the website source code. This source contains the information which is used to create a calendar entry. # Download -Currently this application is in the submitting process to FDroid. see also [#2](/../../issues/2). +Currently this application is in the submission process to F-Droid. see also [#2](/../../issues/2). -Until it is published at FDroid, use [release v0.3.1](https://github.com/akaessens/NoFbEventScraper/releases/download/v0.3.1/app-release.apk). +Until it is published at F-Droid, use the latest [release](https://github.com/akaessens/NoFbEventScraper/releases/latest/download/app-release.apk). + + + +# Building + +This Android app is written in Java and is using the Gradle build system. To compile it, i recommend using Android Studio. +``` +./gradlew build +``` # Screenshots Screenshot 1 Screenshot 2 Screenshot 3 Screenshot 4 +