From 6d0631c1e00341cafc6f60aa4595f3160174b8e7 Mon Sep 17 00:00:00 2001 From: Ivo Wetzel Date: Sun, 6 Feb 2011 20:43:01 +0100 Subject: [PATCH] Use the intro as the README --- README.md | 57 +++++++++++++++++++++++++++---------------------------- 1 file changed, 28 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index b066ba15..0ce65c76 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,41 @@ -JavaScript Garden - A Guide for Core JavaScript -=============================================== +## Intro **JavaScript Garden** is a growing collection of documentation about the most -quirky parts of the JavaScript. It gives advice to avoid common coding -mistakes, subtle bugs, as well as performance issues non expert JavaScript -programmers may encounter on their endeavours into the depths of the language. +quirky parts of the JavaScript programming language. It gives advice to +avoid common mistakes, subtle bugs, as well as performance issues and bad +practices that non-expert JavaScript programmers may encounter on their +endeavours into the depths of the language. JavaScript Garden does **not** insist on teaching JavaScript. Former knowledge -of the language is recommended in order to understand the topics covered in this -guide. If you want to learn the language first, please head over to the excellent -[Guide][1] on the Mozilla Developer Network. +of the language is strongly recommended in order to understand the topics covered +in this guide. In order to learn the basics of the language, please head over to +the excellent [guide][1] on the Mozilla Developer Network. -### License - -JavaScript Garden is published under the MIT license and hosted on -[GitHub](https://github.com/BonsaiDen/JavaScript-Garden). If you find errors or -typos please file an issue or a pull request on the repository. - -[1]: https://developer.mozilla.org/en/JavaScript/Guide +### The authors +This guide is the work of two lovely Stack Overflow users, [Ivo Wetzel][6] +(Writing) and [Zhang Yi Jiang][5] (Design). -TODO ----- +If case you are interested in additional guidance or reviews concerning your JavaScript +projects, Ivo Wetzel offers these on a freelance basis. Please feel free to +contact him via [e-mail][7] for further details. -- Copy-Editing -- More consistency in the wording -- Clean up code examples +### Contributors -Add the following sections: - - - The Global Object - - Converting Numbers + - [Caio Romão][8] (Spelling corrections) +### License -License -------- +JavaScript Garden is published under the [MIT license][2] and hosted on +[GitHub][4]. If you find errors or typos please [file an issue][3] or a pull +request on the repository. -JavaScript Garden is published under the MIT license and hosted on -[GitHub](https://github.com/BonsaiDen/JavaScript-Garden). If you find errors or -typos please file an issue or a pull request on the repository. +[1]: https://developer.mozilla.org/en/JavaScript/Guide +[2]: https://github.com/BonsaiDen/JavaScript-Garden/blob/next/LICENSE +[3]: https://github.com/BonsaiDen/JavaScript-Garden/issues +[4]: https://github.com/BonsaiDen/JavaScript-Garden +[5]: http://stackoverflow.com/users/313758/yi-jiang +[6]: http://stackoverflow.com/users/170224/ivo-wetzel +[7]: mailto:ivo.wetzel@googlemail.com +[8]: https://github.com/caio