Giter Club home page Giter Club logo

bitscuit-library's Introduction

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.

Logo

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.

    gifdown

  • 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

portfolio linkedin twitter

bitscuit-library's People

Contributors

arpitmx avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.