Skip to content

Commit 8577046

Browse files
author
Clauderic Demers
committed
Fix typos and tweak documentation
1 parent 981eaca commit 8577046

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
> A set of higher-order components to turn any list into an animated, touch-friendly, sortable list.
33
44
[![npm version](https://img.shields.io/npm/v/react-sortable-hoc.svg)](https://www.npmjs.com/package/react-sortable-hoc)
5-
![npm downloads](https://img.shields.io/npm/dm/react-sortable-hoc.svg)
5+
[![npm downloads](https://img.shields.io/npm/dm/react-sortable-hoc.svg)](https://www.npmjs.com/package/react-sortable-hoc)
66
[![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)](https://github.com/clauderic/react-sortable-hoc/blob/master/LICENSE)
77
[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)
88
[![Gitter](https://badges.gitter.im/clauderic/react-sortable-hoc.svg)](https://gitter.im/clauderic/react-sortable-hoc)
@@ -108,25 +108,32 @@ More code examples are available [here](https://github.com/clauderic/react-sorta
108108

109109
\* `OffsetValue` is either a finite `Number` or a `String` made-up of a number and a unit (`px` or `%`).
110110
Examples: `10` (is the same as `"10px"`), `"50%"`
111+
\* `OffsetValue` can either be a finite `Number` or a `String` made up of a number and a unit (`px` or `%`).
112+
Examples: `10` (which is the same as `"10px"`), `"50%"`
111113

112114
#### SortableElement HOC
113115
| Property | Type | Default | Required? | Description |
114116
|:-----------|:-----------------|:--------|:---------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
115117
| index | Number | || This is the element's sortableIndex within it's collection. This prop is required. |
116118
| collection | Number or String | `0` | | The collection the element is part of. This is useful if you have multiple groups of sortable elements within the same `SortableContainer`. [Example](http://clauderic.github.io/react-sortable-hoc/#/basic-configuration/multiple-lists) |
117119
| disabled | Boolean | `false` | | Whether the element should be sortable or not |
118-
Why shoud I use this?
120+
121+
Why should I use this?
119122
--------------------
120123
There are already a number of great Drag & Drop libraries out there (for instance, [react-dnd](https://github.com/gaearon/react-dnd/) is fantastic). If those libraries fit your needs, you should definitely give them a try first. However, most of those libraries rely on the HTML5 Drag & Drop API, which has some severe limitations. For instance, things rapidly become tricky if you need to support touch devices, if you need to lock dragging to an axis, or want to animate the nodes as they're being sorted. React Sortable HOC aims to provide a simple set of higher-order components to fill those gaps. If you're looking for a dead-simple, mobile-friendly way to add sortable functionality to your lists, then you're in the right place.
121124

122125
Dependencies
123126
------------
124-
React Sortable List has very few dependencies. It depends on `invariant` and a couple `lodash` functions. It has the following peerDependencies: `react`, `react-dom`
127+
React Sortable List has very few dependencies. It depends on `invariant` and a handful of `lodash` helpers. It has the following peerDependencies: `react`, `react-dom`
125128

126129
Reporting Issues
127130
----------------
128131
If believe you've found an issue, please [report it](https://github.com/clauderic/react-sortable-hoc/issues) along with any relevant details to reproduce it. The easiest way to do so is to fork this [jsfiddle](https://jsfiddle.net/clauderic/6r7r2cva/).
129132

133+
Asking for help
134+
----------------
135+
Please do not use the issue tracker for personal support requests. Instead, use [Gitter](https://gitter.im/clauderic/react-sortable-hoc) or StackOverflow.
136+
130137
Contributions
131138
------------
132139
Yes please! Feature requests / pull requests are welcome.

0 commit comments

Comments
 (0)