Skip to content

Commit 85adf98

Browse files
davinctordavinctor
committed
update:
Updated README. Added reference to MIGRATION.md and CHANGELOG.md
1 parent 0de47e2 commit 85adf98

File tree

2 files changed

+23
-79
lines changed

2 files changed

+23
-79
lines changed

‎CHANGELOG.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,6 @@ at info@cleveroad.com (email subject: «Sliding android app tutorial. Support re
3737
<br><a href="https://twitter.com/CleveroadInc">Twitter account</a>
3838
<br><a href="https://plus.google.com/+CleveroadInc/">Google+ account</a>
3939

40-
[migration manuals]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/MIGRATION.md
41-
[changelog history]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/CHANGELOG.md
4240
[SimplePageFragment]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/SimplePageFragment.java
4341
[PageFragment]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/PageFragment.java
4442
[PageFragment#getLayoutResId()]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/PageFragment.java#L123

‎README.md

Lines changed: 23 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ public class CustomTutorialFragment extends TutorialFragment {
234234
.setElementSpacingRes(R.dimen.indicator_spacing)
235235
.setElementColorRes(android.R.color.darker_gray)
236236
.setSelectedElementColor(android.R.color.white)
237-
.setRenderer(BitmapRenderer.create(getContext()))
237+
.setRenderer(Drawable.create(getContext()))
238238
.build())
239239
.build();
240240
}
@@ -271,34 +271,7 @@ public class CustomTutorialFragment extends TutorialFragment
271271
}
272272

273273
}
274-
```
275-
276-
## Changelog
277-
278-
Version | Changes
279-
--- | ---
280-
v.1.0.0 | Library fully refactored. See full [1.0.0 Changelog](#100_Changelog)
281-
v.0.9.5 | Added getters for views. Possible fix for manifest merging issues
282-
v.0.9.4 | Renamed all attributes; all resources marked as private |
283-
v.0.9.3 | Fixed issue with wrong page showed at startup if pages count not equals 3
284-
v.0.9.2 | Added onSkipButtonClicked method and SimplePagerFragment
285-
v.0.9.1 | Added infinite scroll behavior
286-
v.0.9 | First public release
287-
288-
## 1.0.0 Changelog
289-
* Renamed **PresentationPagerFragment** to [TutorialFragment].
290-
* Made [PageFragment] not abstract with default implementaion for [PageFragment#getLayoutResId()] and [PageFragment#getTransformItems()].
291-
* Removed capability to create new instance of [TransformItem] via `new`. Added fabric static method [TransformItem#create(int,Direction,float)].
292-
* Created [OnTutorialPageChangeListener] to listen change page events.
293-
* Use [TutorialFragment#addOnTutorialPageChangeListener()] and [TutorialFragment#removeOnTutorialPageChangeListener()] to add/remove listener.
294-
* Created [TutorialOptions] to configure [TutorialFragment].
295-
* Created [TutorialPageOptionsProvider] and [PageOptions] to provide and configure [PageFragment] instances.
296-
* Created [TutorialPageProvider] to provide [PageFragment] instances.
297-
* Removed **CirclePageIndicator**.
298-
* Created [TutorialPageIndicator] view.
299-
* Created [IndicatorOptions] to configure [TutorialPageIndicator] view.
300-
* Created [Renderer] interface that responds for drawing single indicator item. There are 2 default implementaion: [Renderer.Factory#newCircleRenderer()] and [Renderer.Factory#newSquareRenderer()].
301-
274+
```
302275

303276
## Migrations from v.0.9.5 to v.1.0.0
304277
1. You must change creation TransformItem from `new TransformItem(R.id.ivFirstImage, true, 20)` to `TransformItem.create(R.id.ivFirstImage, Direction.LEFT_TO_RIGHT, 0.2f)`, where 2-nd parameter now is **Direction** of view translation and 3-rd parameter is *shiftCoefficient*.
@@ -324,39 +297,10 @@ private final TutorialPageProvider mTutorialPageProvider = new TutorialPageProvi
324297
}
325298
};
326299
```
300+
See others [migration manuals].
327301

328-
## Migrations from v.0.9.3 to v.0.9.4
329-
* All resources marked as private. Make sure you're not using any resource (strings, dimens, etc) from this library.
330-
* All attributes were renamed, prefix `st_` added. Add this prefix to any custom XML attribute you used. Example:
331-
```XML
332-
<com.cleveroad.slidingtutorial.CirclePageIndicator
333-
android:id="@+id/indicator"
334-
android:layout_width="match_parent"
335-
android:layout_height="wrap_content"
336-
android:layout_gravity="center"
337-
app:st_fillColor="@android:color/white"
338-
app:st_pageColor="@android:color/secondary_text_light_nodisable"
339-
app:st_radius="4dp"
340-
app:st_strokeColor="#00000000"
341-
app:st_strokeWidth="0dp"/>
342-
```
343-
344-
## Migrations from v.0.9 to v.0.9.1
345-
####CirclePageIndicator
346-
This class is final now. Make sure you're not extending from it.
347-
348-
####LayersHolder
349-
This class is package-local now. Make sure you're not using it.
350-
351-
####PageFragment
352-
**getRootResId()** and **getBackgroundColorResId()** methods are deprecated. You can remove them now. To specify page's color use **PresentationPagerFragment.getPageColor(int)** method.
353-
354-
####PresentationPagerFragment
355-
**getPageFragments()** method is deprecated. You can remove it now. Use **getPagesCount()** and **getPage(int)** methods instead.
356-
357-
Added **isInfinityScrollEnabled()** method. Override it and return `true` to enable this feature.
358-
359-
**NOTE:** make sure you're returning new fragment instance when displaying tutorial with infinite scroll enabled.
302+
## Changelog
303+
See [changelog history].
360304

361305
## Support
362306
If you have any questions regarding the use of this tutorial, please contact us for support
@@ -393,6 +337,8 @@ at info@cleveroad.com (email subject: «Sliding android app tutorial. Support re
393337
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
394338
SOFTWARE.
395339

340+
[migration manuals]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/MIGRATION.md
341+
[changelog history]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/CHANGELOG.md
396342
[PageFragment]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/PageFragment.java
397343
[PageFragment#getLayoutResId()]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/PageFragment.java#L123
398344
[PageFragment#getTransformItems()]: hhttps://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/PageFragment.java#L128
@@ -401,26 +347,26 @@ at info@cleveroad.com (email subject: «Sliding android app tutorial. Support re
401347
[IndicatorOptions.Builder]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/IndicatorOptions.java#L92
402348
[PageOptions]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/PageOptions.java
403349
[Renderer]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/Renderer.java
404-
[Renderer.Factory]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/Renderer.java#L46
405-
[Renderer.Factory#newCircleRenderer()]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/Renderer.java#L54
406-
[Renderer.Factory#newSquareRenderer()]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/Renderer.java#L75
407-
[DrawableRenderer]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/sample/src/main/java/com/cleveroad/slidingtutorial/sample/renderer/DrawableRenderer.java
408-
[RhombusRenderer]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/sample/src/main/java/com/cleveroad/slidingtutorial/sample/renderer/RhombusRenderer.java
350+
[Renderer.Factory]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/feature/refactor/lib/src/main/java/com/cleveroad/slidingtutorial/Renderer.java#L46
351+
[Renderer.Factory#newCircleRenderer()]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/feature/refactor/lib/src/main/java/com/cleveroad/slidingtutorial/Renderer.java#L54
352+
[Renderer.Factory#newSquareRenderer()]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/feature/refactor/lib/src/main/java/com/cleveroad/slidingtutorial/Renderer.java#L75
353+
[DrawableRenderer]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/feature/refactor/sample/src/main/java/com/cleveroad/slidingtutorial/sample/renderer/DrawableRenderer.java
354+
[RhombusRenderer]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/feature/refactor/sample/src/main/java/com/cleveroad/slidingtutorial/sample/renderer/RhombusRenderer.java
409355
[TransformItem]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TransformItem.java
410-
[TransformItem#create(int,Direction,float)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TransformItem.java#L54
356+
[TransformItem#create(int,Direction,float)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/feature/refactor/lib/src/main/java/com/cleveroad/slidingtutorial/TransformItem.java#L54
411357
[TutorialFragment]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialFragment.java
412-
[TutorialFragment.OnTutorialPageChangeListener]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialFragment.java#L315
413-
[TutorialFragment#addOnTutorialPageChangeListener(OnTutorialPageChangeListener)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialFragment.java#L173
414-
[TutorialFragment#removeOnTutorialPageChangeListener(OnTutorialPageChangeListener)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialFragment.java#L186
358+
[TutorialFragment.OnTutorialPageChangeListener]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/feature/refactor/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialFragment.java#L315
359+
[TutorialFragment#addOnTutorialPageChangeListener(OnTutorialPageChangeListener)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/feature/refactor/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialFragment.java#L173
360+
[TutorialFragment#removeOnTutorialPageChangeListener(OnTutorialPageChangeListener)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/feature/refactor/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialFragment.java#L186
415361
[TutorialOptions]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialOptions.java
416362
[TutorialOptions.Builder]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialOptions.java#L112
417-
[TutorialOptions.Builder#setTutorialPageProvider(TutorialPageOptionsProvider)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialOptions.java#L237
418-
[TutorialOptions.Builder#setTutorialPageProvider(TutorialPageProvider)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialOptions.java#L256
419-
[TutorialOptions.Builder#setOnSkipClickListener(OnClickListener)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialOptions.java#L207
420-
[TutorialOptions.Builder#setPagesColors(int array)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialOptions.java#L196
421-
[TutorialOptions.Builder#setPagesCount(int)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialOptions.java#L185
422-
[TutorialOptions.Builder#setUseInfiniteScroll(boolean)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialOptions.java#L174
423-
[TutorialOptions.Builder#setUseAutoRemoveTutorialFragment(boolean)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialOptions.java#L162
363+
[TutorialOptions.Builder#setTutorialPageProvider(TutorialPageOptionsProvider)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/feature/refactor/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialOptions.java#L237
364+
[TutorialOptions.Builder#setTutorialPageProvider(TutorialPageProvider)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/feature/refactor/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialOptions.java#L256
365+
[TutorialOptions.Builder#setOnSkipClickListener(OnClickListener)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/feature/refactor/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialOptions.java#L207
366+
[TutorialOptions.Builder#setPagesColors(int array)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/feature/refactor/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialOptions.java#L196
367+
[TutorialOptions.Builder#setPagesCount(int)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/feature/refactor/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialOptions.java#L185
368+
[TutorialOptions.Builder#setUseInfiniteScroll(boolean)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/feature/refactor/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialOptions.java#L174
369+
[TutorialOptions.Builder#setUseAutoRemoveTutorialFragment(boolean)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/feature/refactor/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialOptions.java#L162
424370
[TutorialPageIndicator]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialPageIndicator.java
425371
[TutorialPageOptionsProvider]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialPageOptionsProvider.java
426372
[TutorialPageProvider]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialPageProvider.java

0 commit comments

Comments
 (0)