Skip to content

Commit

Permalink
update readme, add header image and license
Browse files Browse the repository at this point in the history
  • Loading branch information
ronnielsen committed Sep 7, 2017
1 parent 11c8cc4 commit 10d5ed6
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 23 deletions.
9 changes: 9 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
The MIT License (MIT)

Copyright (c) 2017 Ramotion

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
62 changes: 39 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
TODO: add header
![header](./header.png)

# Garland View for Android
[![Twitter](https://img.shields.io/badge/Twitter-@Ramotion-blue.svg?style=flat)](http://twitter.com/Ramotion)

## About
This project is maintained by Ramotion, Inc.<br>
We specialize in the designing and coding of custom UI for Mobile Apps and Websites.<br>

**Looking for developers for your project?**<br>
This project is maintained by Ramotion, Inc. We specialize in the designing and coding of custom UI for Mobile Apps and Websites.

TODO: add images and animation

<a href="https://ramotion.com/?utm_source=gthb&utm_medium=special&utm_campaign=garland-view-android-contact-us/#Get_in_Touch">
<img src="https://github.com/ramotion/gliding-collection/raw/master/contact_our_team@2x.png" width="187" height="34"></a> <br>


The [Android mockup](https://store.ramotion.com?utm_source=gthb&utm_medium=special&utm_campaign=garland-view-android) available [here](https://store.ramotion.com/product/htc-one-a9-mockups?utm_source=gthb&utm_medium=special&utm_campaign=garland-view-android).

## Requirements
Expand All @@ -16,41 +21,52 @@ TODO: add images and animation

## Basic usage

`GarlandView` consists of classes for inner items, those that are scrolled vertically.
And outer items, those that are scrolled horizontally and each of which contains,
`GarlandView` consists of classes for inner items that are scrolled vertically
and outer items that are scrolled horizontally, and each of which contains
one inner item.

First of all, you need to implement the classes necessary to create internal items.
These are the classes: InnerItem and InnerAdapter.
First of all, you need to implement the classes necessary to create internal items: InnerItem and InnerAdapter.

`InnerAdapter` is an abstract class inherited from RecyclerView.Adapter,
It works only with InnerItem - ViewHolder. An example implementation, see the example.
`InnerAdapter` is an abstract class inherited from RecyclerView.Adapter.
It works only with InnerItem - ViewHolder.

In `InnerItem`, you need to override the `getInnerLayout` method, which must return
main layout of the inner item. An example implementation, see the example.
the main layout of the inner item.

Next, you need to override the classes required for external items.
These are the classes: `HeaderItem` and` HeaderAdapter`
Next, you need to override the classes required for external items: `HeaderItem` and` HeaderAdapter`.

`HeaderAdapter` is an abstract class inherited from RecyclerView.Adapter,
It works only with HeaderItem - ViewHolder. An example implementation, see the example.
It works only with HeaderItem - ViewHolder.

In `HeaderItem`, you need to redefine 4 methods:` getHeader`, `getHeaderAlphaView`,` isScrolling`, `getViewGroup`.
The method `getViewGroup` should return InnerRecyclerView.
The `isScrolling` method must return the InnerRecyclerView's scrolling state.
The `getHeaderAlpha` method should return alpha-layout, which will be used for dimming (hiding header's views).
The `getHeaderAlpha` method should return an alpha-layout, which will be used for dimming (hiding header's views).
The `getHeader` method must return the main layout of the header, an outer item.
An example implementation, see the example.

Finally, in the Activity's layout, place `TailRecyclerView`. Next, create a TailLayoutManager and
specify it as a LayoutManager, for `TailRecyclerView`. An example implementation, see the example.
Finally, place `TailRecyclerView` in the Activity's layout. Next, create a TailLayoutManager and
specify it as a LayoutManager for `TailRecyclerView`.

Here are the attributes of `TailRecyclerView` you can specify in the XML layout:
*`itemStart` - Outer item left and right offset size.
*`itemGap` - Distance between outer items.

## Installation
TODO: write Installation

## License
TODO: add License
CardSlider for Android is released under the MIT license.
See [LICENSE](./LICENSE.md) for details.

# Get the Showroom App for iOS to give it a try
Try our UI components in our iOS app. Contact us if interested.

<a href="https://itunes.apple.com/app/apple-store/id1182360240?pt=550053&ct=garland-view-android&mt=8" >
<img src="https://github.com/ramotion/gliding-collection/raw/master/app_store@2x.png" width="117" height="34"></a>
<a href="https://ramotion.com/?utm_source=gthb&utm_medium=special&utm_campaign=garland-view-android-contact-us/#Get_in_Touch">
<img src="https://github.com/ramotion/gliding-collection/raw/master/contact_our_team@2x.png" width="187" height="34"></a>
<br>
<br>

Follow us for the latest updates
<br>
[![Twitter URL](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=https://github.com/ramotion/garland-vew-android)
[![Twitter Follow](https://img.shields.io/twitter/follow/ramotion.svg?style=social)](https://twitter.com/ramotion)
Binary file added header.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 10d5ed6

Please sign in to comment.