Actualiser README.md

README.md

@@ -1,3 +1,38 @@
 # cafe-townsend
 
-Openfl Cairngorm example
+# Cafe Townsend
+
+This example app demonstrates how to use the [feathersui-cairngorm](https://github.com/feathersui/feathersui-cairngorm) framework to organize the code in a [Feathers UI](https://feathersui.com/) application.
+
+This project is based on a popular Cairngorm sample for Adobe Flex from the community-managed CairngormDocs website (which no longer exists).
+
+## Live demo
+
+A build of the [_cafe-townsend_ sample](https://feathersui.com/samples/haxe-openfl/cairngorm/cafe-townsend/) is hosted on the Feathers UI website, and it may be viewed in any modern web browser.
+
+## Run locally
+
+This project includes an [_project.xml_](https://lime.software/docs/project-files/xml-format/) file that configures all options for [OpenFL](https://openfl.org/). This file makes it easy to build from the command line, and many IDEs can parse this file to configure a Haxe project to use OpenFL.
+
+### Prerequisites
+
+- [Install Haxe 4.1 or newer](https://haxe.org/download/)
+- [Install Feathers UI from Haxelib](https://feathersui.com/learn/haxe-openfl/installation/)
+
+### Command Line
+
+Run the [**openfl**](https://www.openfl.org/learn/haxelib/docs/tools/) tool in your terminal:
+
+```sh
+haxelib run openfl test html5
+```
+
+In addition to `html5`, other supported targets include `windows`, `mac`, `linux`, `android`, and `ios`. See [Lime Command Line Tools: Basic Commands](https://lime.software/docs/command-line-tools/basic-commands/) for complete details about the available commands.
+
+### Editors and IDEs
+
+Check out the following tutorials for creating Feathers UI projects in popular development environments:
+
+- [HaxeDevelop](https://feathersui.com/learn/haxe-openfl/haxedevelop/)
+- [Moonshine IDE](https://feathersui.com/learn/haxe-openfl/moonshine-ide/)
+- [Visual Studio Code](https://feathersui.com/learn/haxe-openfl/visual-studio-code/)