README.md

Sushi Design System

⚡️ Android UI Kit ⚡️

Application is available here:

Latest release:

Usage

The master branch is being used for release and dev is the default branch.

Installation

This package is available via Github Package Registry. To use this, follow these steps.

Add the Github Maven repository and the dependency in your app's build.gradle

repositories {
    // ... google(), jcenter() etc
    maven {
        url "https://maven.pkg.github.com/Zomato/sushi-ui-android"
        credentials(HttpHeaderCredentials) {
            name = "Authorization"
            value = "token ${System.getenv("GITHUB_TOKEN")}"
        }
        authentication { header(HttpHeaderAuthentication) }
    }
}

dependencies {
    // ... other dependencies
    implementation "com.zomato.sushilib:sushilib-android:${latest_version}"
}

NOTE: Make sure you have the GITHUB_TOKEN environment variable set. This token should have read:packages enabled.

Documentation

A delicious UI Kit to build Android apps. Made with ❤ by Zomato
https://zomato.github.io/sushi-ui-android/

Testing & Coverage

Run all tests and get coverage report

./gradlew jacocoTestReport

Publishing

To publish this package, go to Actions tab of the repo and select "Version Bump CI" workflow. This workflow has to be manually triggered by clicking "Run Workflow" button. It will create a PR on "master" branch which after merge will generate and publish a new package.

License

Copyright 2022 Zomato Limited.

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.