README.md

bitscuit 🍪

bitscuit updater is an android library which the developers can hook into their project and use it to update their apps in just 3 lines of code.

Applications

bitscuit is suited for those application :

• Apps which aren't hosted on any store like google play store
• Distributing updates apps to testers
• Apps which have more frequent updates cause app stores like playstore takes a lot of time (1-2 day) for verification of each update
• For updates involving minor upgrades in the app

Features

• Easy integration : bitscuit can be easily integrated into any Android app with just three lines of code, handles permissions, configurations, version comparisions,etc. saving developers valuable time and effort, why recreating the wheel? right.

  
  
  
  

• Seamless updates : bitscuit ensures that app updates happen seamlessly, without interrupting user experience or requiring the user to manually update the app.

  

  

• Error handling : bitscuit handles errors and edge cases like connection problems gracefully, ensuring that the update process is as smooth and error-free as possible for both developers and users.

  
  
  
  
  

Bitscuit usage

This is a sample code to listen update using bitscuit:

 ...

// Use the buitscuit builder to create the bitscuit instance 
val bitscuit = Bitscuit.BitscuitBuilder(this)
                    .config(url = _UPDATE_URL_ ,version=_LATEST_VERSION_ , changeLogs=_CHANGE_LOGS_ )
                    .build() 
  
       
// Use the listenUpdate() function to start listening for updates 
  bitscuit.listenUpdate()   

 ...                 
                    

Installation

Installing bistcuit is very simple , you can install bitscuit using github release by downloading the latest jar file

Using Gradle

Step 1 : Use this in build.gradle(module: project)

  allprojects {
		repositories {
			...
			maven { url 'https://jitpack.io' }
		}
	}

//For Gradle 7.0 and above add 'maven { url 'https://jitpack.io' }' in settings.gradle file


dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven { url 'https://jitpack.io' }
    }
}

Step 2 : Use this in build.gradle(module: app)

 dependencies {
	    implementation 'com.github.arpitmx:bitscuit:1.0.5'
	}

Using Maven

<repositories>
	<repository>
		<id>jitpack.io</id>
		<url>https://jitpack.io</url>
	</repository>
</repositories>

<dependency>
 	<groupId>com.github.arpitmx</groupId>
	<artifactId>bitscuit</artifactId>
	<version>1.0.6</version>
</dependency>

Do not forget to add internet permission in manifest if already not present

<uses-permission android:name="android.permission.INTERNET" />

License

   Copyright (C) 2023 Alok Ranjan

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

   

Contributing to bitscuit

All pull requests are welcome, make sure to follow the contribution guidelines when you submit pull request.

Links