diff --git a/README.md b/README.md index dc855fd9..33ddbe97 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,97 @@ # MaterialShowcaseView A Material Design themed ShowcaseView for Android + +This library is heavily inspired by the original [ShowcaseView library][1]. + +Since Google introduced the Material design philosophy I have seen quite a few apps with a nice clean, flat showcase view (the Youtube app is a good example). The only library out there however is the [original one][1]. This was a great library for a long time but the theming is now looking a bit dated. + +![Logo](http://i.imgur.com/QIMYRJh.png) + + +![Animation][2] + +How to use +-------- +This is the basic usage of a single showcase view, you should check out the sample app for more adbvanced usage. + +```java + + // single example + new MaterialShowcaseView.Builder(this) + .setTarget(mButtonShow) + .setDismissText("GOT IT") + .setContentText("This is some amazing feature you should know about") + .setDelay(withDelay) // optional but starting animations immediately in onCreate can make them choppy + .singleUse(SHOWCASE_ID) // provide a unique ID used to ensure it is only shown once + .show(); + + + + + // sequence example + ShowcaseConfig config = new ShowcaseConfig(); + config.setDelay(500); // half second between each showcase view + + MaterialShowcaseSequence sequence = new MaterialShowcaseSequence(this, SHOWCASE_ID); + + sequence.setConfig(config); + + sequence.addSequenceItem(mButtonOne, + "This is button one", "GOT IT"); + + sequence.addSequenceItem(mButtonTwo, + "This is button two", "GOT IT"); + + sequence.addSequenceItem(mButtonThree, + "This is button three", "GOT IT"); + + sequence.start(); + +``` + + +Gradle +-------- + +Add jitpack to your your build.gradle at the end of repositories: + +/build.gradle +```groovy +repositories { + // ... + maven { url "https://jitpack.io" } + } +``` + +Add the dependency: + +/app/build.gradle +```groovy +compile 'com.github.deano2390:MaterialShowcaseView:1.0.0' +``` + + +License +------- + + Copyright 2015 Dean Wild + + 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. + + + + + +[1]: https://github.com/amlcurran/ShowcaseView +[2]: http://i.imgur.com/rFHENgz.gif +[3]: https://code.google.com/p/android-flowtextview/