Skip to content

Commit

Permalink
docs(readme): reformat at 80 characters and include browserstack link
Browse files Browse the repository at this point in the history
By including this, _BrowserStack_ will allow us to do free testing of
the site on their platform.
  • Loading branch information
skipjack committed Dec 26, 2017
1 parent a5566a1 commit 0d6cb2e
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 15 deletions.
44 changes: 29 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,61 @@
# webpack.js.org

[![build status](https://secure.travis-ci.org/webpack/webpack.js.org.svg)](http://travis-ci.org/webpack/webpack.js.org)
[![Standard Version](https://img.shields.io/badge/release-standard%20version-brightgreen.svg)](https://github.com/conventional-changelog/standard-version)
[![Build Status][13]][10]
[![Standard Version][12]][11]

Guides, documentation, and all things webpack.


## Content Progress

Now that we've covered much of the backlog of _missing documentation_, we are starting
to heavily review each section of the site's content to sort and structure it appropriately.
The following issues should provide a pretty good idea of where things are, and where
they are going:
Now that we've covered much of the backlog of _missing documentation_, we are
starting to heavily review each section of the site's content to sort and
structure it appropriately. The following issues should provide a pretty good
idea of where things are, and where they are going:

- [Guides - Review and Simplify][1]
- [Concepts - Review, Organize, Define Clear Goals][2]
- [Concepts - Review and Organize][2]
- [API - v4 Rewrite][8]

We haven't created issues for the other sections yet, but they will be coming soon. For
dev-related work please see [General - Current Longterm Plan][3], which will soon be
replaced by a more dev-specific issue.
We haven't created issues for the other sections yet, but they will be coming
soon. For dev-related work please see [General - Updates & Fixes][3].


## Translation

If you hope to localize this documentation please jump to the [translate branch][4].
To help translate this documentation please jump to the [translate branch][4].


## Contributing

Read through the [writer's guide][7] if you're interested in editing the content on this
site. See the [contributors page][5] to learn how to set up and start working on the site
locally.
Read through the [writer's guide][7] if you're interested in editing the
content on this site. See the [contributors page][5] to learn how to set up and
start working on the site locally.


## License

The content is available under the [Creative Commons BY 4.0][6] license.


## Special Thanks

_BrowserStack_ has graciously allowed us to do cross-browser and cross-os
testing of the site at no cost...

[![BrowserStackLogo](./browserstack-logo.png)][9]


[1]: https://github.com/webpack/webpack.js.org/issues/1258
[2]: https://github.com/webpack/webpack.js.org/issues/1386
[3]: https://github.com/webpack/webpack.js.org/issues/1380
[3]: https://github.com/webpack/webpack.js.org/issues/1525
[4]: https://github.com/webpack/webpack.js.org/tree/translation
[5]: https://github.com/webpack/webpack.js.org/blob/master/.github/CONTRIBUTING.md
[6]: https://creativecommons.org/licenses/by/4.0/
[7]: https://webpack.js.org/writers-guide
[8]: https://github.com/webpack/webpack.js.org/pull/1754
[9]: http://browserstack.com/
[10]: http://travis-ci.org/webpack/webpack.js.org
[11]: https://github.com/conventional-changelog/standard-version
[12]: https://img.shields.io/badge/release-standard%20version-brightgreen.svg
[13]: https://secure.travis-ci.org/webpack/webpack.js.org.svg
Binary file added browserstack-logo.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 0d6cb2e

Please sign in to comment.