Skip to content

Commit

Permalink
Update README with instructions for internal articatory
Browse files Browse the repository at this point in the history
  • Loading branch information
thelukewalton committed Feb 6, 2024
1 parent 838cba9 commit 7de0368
Show file tree
Hide file tree
Showing 2 changed files with 82 additions and 7 deletions.
29 changes: 22 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,30 @@ Zebra Design System components for Android.

## Setup

This has been tested with `compileSdkVersion 34`. Other sdk versions may require additional work.
> 🚧 **Note**: This has been verified with`compileSdkVersion 34`. Other sdk versions may require additional work.
1. Add Zebra Maven repository to `settings.gradle`:
1. ZDS-Android is hosted on Zebra's internal Artifactory repository. Credentials for this are required, and can be obtained by logging onto [Artifactory](https://artifactory-us.zebra.com). Once logged in with SSO, select your username in the top right corner, and select set me up. Select `Maven`, then `Generate Token & Create Instructions`. This generated token is your password.

2. It is recommended for individuals to save their username and password in their global `gradle.properties` file:

```gradle
artifactusername=XXX
artifactpassword=YYY
```

These credentials should **_never_** be shared.

2. Add Zebra Maven repository to `settings.gradle`:

```gradle
dependencyResolutionManagement {
repositories {
maven {
...
url "https://zebratech.jfrog.io/artifactory/zds-android/"
maven{
url "https://artifactory-us.zebra.com/artifactory/dmo-mvn-rel/"
credentials {
username = "${artifactusername}"
password = "${artifactpassword}"
}
}
}
}
Expand All @@ -25,11 +39,12 @@ dependencyResolutionManagement {
dependencies {
...
implementation 'com.zebra:zds:1.0.0'
...
}
```

3. To use and style the components in `AndroidManifest.xml` place in the application tag the base Zebra theme, and be sure to remove other styles if they could override this incorrectly.
Once this is added, your IDE should

3. For the components to work and receive the correct theme values, we must add the theme n `AndroidManifest.xml`. Be sure to remove other themes which could override this and prevent the components from working.

```xml
<application
Expand Down
60 changes: 60 additions & 0 deletions README_public.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# zds-android

Zebra Design System components for Android.

## Setup

This has been tested with `compileSdkVersion 34`. Other sdk versions may require additional work.

1. Add Zebra Maven repository to `settings.gradle`:

```
dependencyResolutionManagement {
repositories {
maven {
...
url "https://zebratech.jfrog.io/artifactory/zds-android/"
}
}
}
```

2. Add dependency to **app-level** `build.gradle`

```
dependencies {
...
implementation 'com.zebra:zds:1.0.0'
...
}
```

3. To use and style the components in `AndroidManifest.xml` place in the application tag the base Zebra theme, and be sure to remove other styles if they could override this incorrectly.

```xml
<application
...
android:theme="@style/Theme.ZdsBase"
...
/>
```

4. Use components. Example:

```xml
<com.zebra.zds.ZdsButton
style="@style/Zds.Button.Primary"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_gravity="center"
android:text="Button"
android:theme="@style/Zds.Button.Primary"/>
```

---

# [Component Documentation](./components/docs/index.md)

---

## [License](./LICENSE)

0 comments on commit 7de0368

Please sign in to comment.