From af8fb557af31df9b4ba2c967a15f1a2f24b39e6b Mon Sep 17 00:00:00 2001 From: Quentin Colle Date: Tue, 15 May 2018 18:08:31 -0400 Subject: [PATCH] Chore - Updated README --- CHANGELOG.md | 6 +++++ LICENSE | 2 +- README.md | 66 ++++++++++++++++++++++++++++------------------------ 3 files changed, 43 insertions(+), 31 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index dfa9d47f..df98ccbe 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ Change Log ========== + +Version 1.5.0 *(2018-05-15)* +---------------------------- +*Update:Dependency has now been migrated to Jitpack. Refer to the installation section to install the latest using gradle. +*Update:Gradle has been updated to the latest. + Version 1.4.3 *(2017-02-21)* ---------------------------- * New: Added set click listener method for title diff --git a/LICENSE b/LICENSE index b0420f2e..318044c8 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2017 Prolific Interactive +Copyright (c) 2018 Prolific Interactive Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 215836d2..a77316e8 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,38 @@ -Material Calendar View -====================== -[![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-Material%20Calendar%20View-blue.svg?style=flat)](https://android-arsenal.com/details/1/1531) [![Maven Central](https://img.shields.io/maven-central/v/com.prolificinteractive/material-calendarview.svg?maxAge=2592000)](http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22material-calendarview%22) [![Travis branch](https://img.shields.io/travis/prolificinteractive/material-calendarview.svg?maxAge=2592000)](https://travis-ci.org/prolificinteractive/material-calendarview) +#Material Calendar View +[![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-Material%20Calendar%20View-blue.svg?style=flat)](https://android-arsenal.com/details/1/1531) [![](https://jitpack.io/v/prolificinteractive/material-calendarview.svg)](https://jitpack.io/#prolificinteractive/material-calendarview) [![Travis branch](https://img.shields.io/travis/prolificinteractive/material-calendarview.svg?maxAge=2592000)](https://travis-ci.org/prolificinteractive/material-calendarview) A Material design back port of Android's CalendarView. The goal is to have a Material look and feel, rather than 100% parity with the platform's implementation. Demo Screen Capture -Usage ------ +## Installation -1. Add `implementation 'com.prolificinteractive:material-calendarview:1.4.3'` to your dependencies. -2. Add `MaterialCalendarView` into your layouts or view hierarchy. -3. Set a `OnDateSelectedListener` or call `MaterialCalendarView.getSelectedDates()` when you need it. +Step 1. Add the JitPack repository to your build file +```groovy +allprojects { + repositories { + ... + maven { url 'https://jitpack.io' } + } +} +``` + +Step 2. Add the dependency + +```groovy +dependencies { + implementation 'com.github.prolificinteractive:material-calendarview:${version}' +} +``` + +## Usage + +1. Add `MaterialCalendarView` into your layouts or view hierarchy. +2. Set a `OnDateSelectedListener` or call `MaterialCalendarView.getSelectedDates()` when you need it. [Javadoc Available Here](http://prolificinteractive.github.io/material-calendarview/) @@ -31,13 +48,14 @@ Example: app:mcv_selectionColor="#00F" /> ``` -#### @Experimental -`CalendarMode.WEEK` and all week mode functionality is officially marked `@Experimental`. All APIs -marked `@Experimental` are subject to change quickly and should not be used in production code. They -are allowed for testing and feedback. -Major Change in 1.4.0 ---------------------- +### Major Change in 1.5.0 + +We recently updated to the latest gradle and decided to move over our libraries to the hosting service Jitpack. +Please refer to the installation section for more details. + +### Major Change in 1.4.0 + * Breaking Change: `setFirstDayOfWeek`, `setMin/MaxDate`, and `setCalendarDisplayMode` are moved to a `State` object. This was necessary because it was unclear that these were not simple setters--individually, they were side effecting and triggered full adapter/date range recalculations. Typical usage of the view involves setting all these invariants up front during `onCreate` and it was unknown to the user that setting all 4 of these would create a lot of waste. Not to mention certain things were side effecting--some would reset the current day or selected date. As a result, the same 4 methods called in a different order could result in a different state, which is bad. For most cases you will simply need to replace setting those invariants with: @@ -57,22 +75,11 @@ Major Change in 1.4.0 See other changes in the [CHANGELOG](/CHANGELOG.md). -Major Change in 1.3.0 ---------------------- -* Breaking change: `getTileSize` is deprecated. Use `getTileWidth` or `getTileHeight`. -* Added `goToNext` and `goToPrevious` API to programmatically trigger paging -* Allow users to click on dates outside of current month with `setAllowClickDaysOutsideCurrentMonth` -* Set tile width/height separately rather than single tile size with `setTileWidth` and `setTileHeight` -* Attributes: mcv_tileWidth, mcv_tileHeight, mcv_calendarMode -* TalkBack APIs: `setContentDescriptionArrowPast`, `ArrowFuture`, `Calendar` - -Documentation -------------- +## Documentation Make sure to check all the documentation available [here](docs/README.md). -Customization -------------- +## Customization One of the aims of this library is to be customizable. The many options include: @@ -94,14 +101,13 @@ All of this and more can be done via the decorator api. Please check out the [de If you provide custom drawables or colors, you'll want to make sure they respond to state. Check out the [documentation for custom states](docs/CUSTOM_SELECTORS.md). -Contributing -============ +# Contributing Would you like to contribute? Fork us and send a pull request! Be sure to checkout our issues first. ## License -Material Calendar View is Copyright (c) 2017 Prolific Interactive. It may be redistributed under the terms specified in the [LICENSE] file. +Material Calendar View is Copyright (c) 2018 Prolific Interactive. It may be redistributed under the terms specified in the [LICENSE] file. [LICENSE]: /LICENSE