<commit_before># Introduction [ ![Download](https://api.bintray.com/packages/rubengees/maven/Introduction/images/download.svg) ](https://bintray.com/rubengees/maven/Introduction/_latestVersion)

Show a beautiful Intro to your users with ease.

![](art/screenshot_gallery.png)

### Include in your Project

Add this to your build.gradle:

```groovy
dependencies {
    compile 'com.rubengees:introduction:1.0.1@aar'
}
```

If that doesn't work, look if there is a new version and the Readme was not updated yet.
If there is no new version and it still doesn't work, try to add this to your build.gradle:

```groovy
repositories {
    maven { url  "http://dl.bintray.com/rubengees/maven" }
}
```

### Usage

Create an `IntroductionBuilder` like the following:

```java
new IntroductionBuilder(this) //this is the Activity you want to start from.
```

Then add some Slides to your Introduction:

```java
new IntroductionBuilder(this).withSlides(generateSlides())
```

```java
 private List<Slide> generateSlides() {
      List<Slide> result = new ArrayList<>();

       result.add(new Slide().withTitle("Some title").withDescription("Some description").
               withColorResource(R.color.green).withImageResource(R.drawable.myImage));
       result.add(new Slide().withTitle("Another title").withDescription("Another description")
               .withColorResource(R.color.indigo).withImageResource(R.drawable.myImage2));

       return result;
    }
```

Finally introduce yourself!

```java
new IntroductionBuilder(this).withSlides(generateSlides()).introduceMyself();
```

That was easy right?

You can do many customizations, which will be covered by the following.

##### Options

You can let the user make decisions, which you can use like settings.
To do that you add an Option to your slide:

```java
new Slide().withTitle("Feature is doing something").withOption(new Option("Enable the feature"))
          .withColorResource(R.color.orange).withImageResource(R.drawable.image));
```

When the user completes the intro, you will receive the selected Options in `onActivityResult`. 
To read the result:

```java
@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {<commit_msg>Update README to reflect the API changes<commit_after># Introduction [ ![Download](https://api.bintray.com/packages/rubengees/maven/Introduction/images/download.svg) ](https://bintray.com/rubengees/maven/Introduction/_latestVersion)

Show a beautiful Intro to your users with ease.

![](art/screenshot_gallery.png)

### Include in your Project

Add this to your build.gradle:

```groovy
dependencies {
    compile 'com.rubengees:introduction:1.0.1@aar'
}
```

If that doesn't work, look if there is a new version and the Readme was not updated yet.
If there is no new version and it still doesn't work, try to add this to your build.gradle:

```groovy
repositories {
    maven { url  "http://dl.bintray.com/rubengees/maven" }
}
```

### Usage

Create an `IntroductionBuilder` like the following:

```java
new IntroductionBuilder(this) //this is the Activity you want to start from.
```

Then add some Slides to your Introduction:

```java
new IntroductionBuilder(this).withSlides(generateSlides())
```

```java
 private List<Slide> generateSlides() {
      List<Slide> result = new ArrayList<>();

       result.add(new Slide().withTitle("Some title").withDescription("Some description").
               withColorResource(R.color.green).withImage(R.drawable.myImage));
       result.add(new Slide().withTitle("Another title").withDescription("Another description")
               .withColorResource(R.color.indigo).withImage(R.drawable.myImage2));

       return result;
    }
```

Finally introduce yourself!

```java
new IntroductionBuilder(this).withSlides(generateSlides()).introduceMyself();
```

That was easy right?

You can do many customizations, which will be covered by the following.

##### Options

You can let the user make decisions, which you can use like settings.
To do that you add an Option to your slide:

```java
new Slide().withTitle("Feature is doing something").withOption(new Option("Enable the feature"))
          .withColorResource(R.color.orange).withImage(R.drawable.image));
```

When the user completes the intro, you will receive the selected Options in `onActivityResult`. 
To read the result:

```java
@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
{'fraction_non_alphanumeric': 0.11997303976634464, 'fraction_numerical': 0.001797348910357223, 'mean_word_length': 4.58594730238394, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4903577', 'n_tokens_mistral': 1339, 'n_tokens_neox': 1244, 'n_words': 408}