Merge pull request #18 from Spikeysanju/Update-Readme

Update README.md

.github/workflows/android_ci.yml

@@ -2,9 +2,9 @@ name: Android CI
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 
 jobs:

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at spikeysanju98@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -3,26 +3,19 @@
 We'd love to accept your patches and contributions to this project. There are
 just a few small guidelines you need to follow.
 
-## Contributor License Agreement
+## Welcome Dev!, Thanks for making our this Epoch App great.
 
-Contributions to this project must be accompanied by a Contributor License
-Agreement. You (or your employer) retain the copyright to your contribution,
-this simply gives us permission to use and redistribute your contributions as
-part of the project. Head over to <https://cla.developers.google.com/> to see
-your current agreements on file or to sign a new one.
+### What you can do
+You can contribute us by filing issues, bugs and PRs.
 
-You generally only need to submit a CLA once, so if you've already submitted one
-(even if it was for a different project), you probably don't need to do it
-again.
-
-## Code reviews
-
-All submissions, including submissions by project members, require review. We
-use GitHub pull requests for this purpose. Consult
-[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
-information on using pull requests.
+### Contributing guidelines:
+- Open issue regarding proposed change.
+- Repo owner will contact you there.
+- If your proposed change is approved, Fork this repo and do changes.
+- Open PR against latest `dev` branch. Add nice description in PR.
+- You're done!
 
 ## Community Guidelines
 
 This project follows [Google's Open Source Community
-Guidelines](https://opensource.google.com/conduct/).
+Guidelines](https://github.com/Spikeysanju/Epoch/blob/master/CODE_OF_CONDUCT.md).

README.md

@@ -1,41 +1,94 @@
-# Template repository
+![GitHub Cards Preview](https://github.com/Spikeysanju/Epoch/blob/main/art/EPOCH-COVER.png?raw=true)
 
-Template repository for the Jetpack Compose [#AndroidDevChallenge](https://developer.android.com/dev-challenge).
+# Epoch ⏱
+Beautiful Countdown timer app built to Demonstrate the Jetpack Compose UI with Animations *Made with love ❤️ by [Spikeysanju](https://github.com/Spikeysanju)*
 
-## Getting started
-Copy this repository by pressing the "Use this template" button in Github.
-Clone your repository and open it in the latest [Android Studio (Canary build)](https://developer.android.com/studio/preview).
+<br />
 
-## Submission requirements
-- Follow the challenge description on the project website: [developer.android.com/dev-challenge](https://developer.android.com/dev-challenge)
-- All UI should be written using Jetpack Compose
-- The Github Actions workflow should complete successfully
-- Include two screenshots of your submission in the [results](results) folder. The names should be
-  screenshot_1.png and screenshot_2.png.
-- Include a screen record of your submission in the [results](results) folder. The name should be
-  video.mp4
-- Replace the contents of [README.md](README.md) with the contents of [README-template.md](README-template.md) and fill out the template.
+***Try latest Epoch app apk from below 👇***
 
-## Code formatting
-The CI uses [Spotless](https://github.com/diffplug/spotless) to check if your code is formatted correctly and contains the right licenses.
-Internally, Spotless uses [ktlint](https://github.com/pinterest/ktlint) to check the formatting of your code.
-To set up ktlint correctly with Android Studio, follow one of the [listed setup options](https://github.com/pinterest/ktlint#-with-intellij-idea).
+[![Epoch](https://img.shields.io/badge/Epoch-APK-black.svg?style=for-the-badge&logo=android)](https://github.com/Spikeysanju/Epoch/releases/download/v1.0.0-alpha01/Epoch.apk)
 
-Before committing your code, run `./gradlew app:spotlessApply` to automatically format your code.
+<br />
+
+## UI Design 🎨
+
+***Click to View Epoch app Design from below 👇***
+
+[![Epoch](https://img.shields.io/badge/Epoch-FIGMA-black.svg?style=for-the-badge&logo=figma)](https://www.figma.com/file/ExpK3ap5TNcHvDdBfXRXM4/Epoch-App?node-id=0%3A1)
+
+<br />
+
+
+## Epoch App Previews 👀
+DISCONNECTED | CONNECTED
+--- | --- |
+![](https://github.com/Spikeysanju/Epoch/blob/main/art/DISCONNECTED-MOCK.png) | ![](https://github.com/Spikeysanju/Epoch/blob/main/art/CONNECTED-MOCK.png)
+
+<br />
+
+## Built With 🛠
+- [Kotlin](https://kotlinlang.org/) - First class and official programming language for Android development.
+- [Jetpack Compose](https://developer.android.com/jetpack/compose) - Jetpack Compose is Android’s modern toolkit for building native UI.
+- [Android Architecture Components](https://developer.android.com/topic/libraries/architecture) - Collection of libraries that help you design robust, testable, and maintainable apps.
+  - [Jetpack Compose Navigation](https://developer.android.com/jetpack/compose/navigation) - Navigation refers to the interactions that allow users to navigate across, into, and back out from the different pieces of content within your app
+- [Material Components for Android](https://github.com/material-components/material-components-android) - Modular and customizable Material Design UI components for Android.
+- [Figma](https://figma.com/) - Figma is a vector graphics editor and prototyping tool which is primarily web-based.
+
+
+<br />
+
+## Build-tool 🧰
+You need to have [Android Studio Beta 3 or above](https://developer.android.com/studio/preview) to build this project.
+<br>
+<img src="./beta_android.png" height="200" alt="Beta-studio"/>
+
+<br>
+
+## Contribute 🤝
+If you want to contribute to this app, you're always welcome!
+See [Contributing Guidelines](https://github.com/Spikeysanju/Epoch/blob/main/CONTRIBUTING.md).
+
+<br>
+
+## Contact 📩
+Got an app/website idea? Let's Connect  🤙
+
+Drop a mail to:- spikeysanju98@gmail.com
+
+<br>
+
+## Donation 💰
+If this project help you reduce time to develop, you can give me a cup of coffee :)
+
+<a href="https://www.buymeacoffee.com/Li0hsl4" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>
+
+<br>
+
+## Credits 🤗
+
+- Icons are from [flaticon.com](https://tablericons.com)
+- Heartly congratulations for Jetpack Compose Team who worked hard to make Compose great ♥️
+
+
+<br />
+
+## License 🔖
 
-## License
 ```
-Copyright 2020 The Android Open Source Project
+   Copyright 2021 Spikey Sanju
 
-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
+   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
 
-    https://www.apache.org/licenses/LICENSE-2.0
+       https://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.
+
+```
 
-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.
-```

app/build.gradle

@@ -84,7 +84,7 @@ dependencies {
     implementation 'androidx.core:core-ktx:1.3.2'
     implementation 'androidx.appcompat:appcompat:1.3.0-beta01'
     implementation 'com.google.android.material:material:1.3.0'
-    implementation "androidx.activity:activity-compose:1.3.0-alpha03"
+    implementation 'androidx.activity:activity-compose:1.3.0-alpha04'
     implementation "androidx.compose.ui:ui:$compose_version"
     implementation "androidx.compose.material:material:$compose_version"
     implementation "androidx.compose.material:material-icons-extended:$compose_version"

app/src/androidTest/java/dev/spikeysanju/epoch/ExampleInstrumentedTest.kt

@@ -14,11 +14,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.example.epoch
+package dev.spikeysanju.epoch
 
 import androidx.compose.ui.test.junit4.createAndroidComposeRule
 import androidx.test.ext.junit.runners.AndroidJUnit4
-import dev.spikeysanju.epoch.MainActivity
 import org.junit.Rule
 import org.junit.Test
 import org.junit.runner.RunWith

app/src/test/java/dev/spikeysanju/epoch/ExampleUnitTest.kt

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.example.epoch
+package dev.spikeysanju.epoch
 
 /**
  * Example local unit test, which will execute on the development machine (host).