From ca3b4dc3331350829dedef2a31d6d3f8dccf538a Mon Sep 17 00:00:00 2001 From: Joel Montes de Oca Date: Thu, 17 Mar 2016 15:35:32 -0400 Subject: [PATCH] General improvements to the README file. Edited some of the wording so that it would read better. Also removed commas when commas are not needed. There were a few commas before the word 'and' when the word 'and' was not separating to independent clauses.. Added a License subheading at the bottom. The README didn't mention which license is used. It should be mentioned in the README so others don't have to click the License text file just to know what the license is. Other minor edits regarding wordy sentence and what not. --- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 6ef3d906fd..8e572084e1 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ lichess.org -It's a free online chess game focused on [realtime](http://lichess.org/games) and ease of use +Lila is a free online chess game server focused on [realtime](http://lichess.org/games) and ease of use. -It has a [search engine](http://lichess.org/games/search), +It features a [search engine](http://lichess.org/games/search), [computer analysis](http://lichess.org/ief49lif), [tournaments](http://lichess.org/tournament), [simuls](http://lichess.org/simul), @@ -15,7 +15,7 @@ It has a [search engine](http://lichess.org/games/search), [opening trainer](http://lichess.org/training/opening), a [mobile app](http://lichess.org/mobile), and a [network world map](http://lichess.org/network). -The UI is available in [80 languages](http://lichess.org/translation/contribute) thanks to the community. +The UI is available in more than [80 languages](http://lichess.org/translation/contribute) thanks to the community. Lichess is written in [Scala 2.11](http://www.scala-lang.org/), and relies on [Play 2.3](http://www.playframework.com/) for the routing, templating, and JSON. @@ -33,9 +33,9 @@ Use [github issues](https://github.com/ornicar/lila/issues) for bug reports and Installation ------------ -> If you want to add a live chess section to your website, you are welcome to [embed lichess](http://lichess.org/developers). It's very easy. +> If you want to add a live chess section to your website, you are welcome to [embed lichess](http://lichess.org/developers) into your website. It's very easy to do. -> This project source code is open for other developers to have an example of non-trivial scala/play2/mongodb application. You're welcome to reuse as much code as you want for your projects, and to get inspired by the solutions I propose to many common web development problems. But please don't just create a public lichess clone. Instead, just [embed lichess using an <iframe>](http://lichess.org/developers). +> This project source code is open for other developers to have an example of non-trivial scala/play2/mongodb application. You're welcome to reuse as much code as you want for your projects and to get inspired by the solutions I propose to many common web development problems. But please don't just create a public lichess clone. Instead, [embed lichess using an <iframe>](http://lichess.org/developers) into your website. > Also note that if I provide the source code, I do **not** offer support for your lichess instance. I will probably ignore any question about lichess installation and runtime issues. @@ -44,7 +44,7 @@ Installation Feel free to use lichess API in your applications and websites. If the resource you need is not available yet, -drop me an email at thibault.duplessis@gmail.com, and we'll discuss it. +drop me an email at thibault.duplessis@gmail.com and we'll discuss it. ### `GET /api/user/` fetch one user @@ -386,4 +386,9 @@ We also do our best to support: - Opera 34 and newer - Safari 9 and newer -Others and older browsers are guaranteed not to work with lichess, and we don't care. +Others and older browsers are guaranteed not to work with lichess and we don't care. + +Licence +------- + +Lila is realeased under the MIT license.