Update README

Author: deathaxe

.gitattributes

@@ -1,4 +1,11 @@
-/.github/           export-ignore
-/.gitattributes     export-ignore
-/.gitignore         export-ignore
-/tests				export-ignore
+# git
+.github/        export-ignore
+.git            export-ignore
+.gitattributes  export-ignore
+.gitignore      export-ignore
+# development
+tests/          export-ignore
+*.cmd           export-ignore
+# other
+logo.*          export-ignore
+preview.*       export-ignore

README.md

@@ -1,71 +1,71 @@
-## Overview
+# CoffeeScript <img src="logo.svg" title="CoffeeScript" width="32" height="32">
 
-**This package is for Sublime Text 3+**.
-An old version for Sublime Text 2 is accessible via the [`st2` branch](https://github.com/SublimeText/BetterCoffeeScript/tree/st2).
-
-## Description
+[CoffeeScript](https://coffeescript.org/) syntax definitions build system and snippets for [Sublime Text](https://www.sublimetext.com).
 
-CoffeeScript plug-in was originally created by @Xavura. As I, @aponxi, began writing a lot of code in CoffeeScript, I felt the need for side-by-side view for compiled CoffeeScript. Since Xavura's repository have been inactive I decided to branch out my own version. The biggest change in my branch is the Watch Mode which updates the compiled JavaScript view whenever you modify the CoffeeScript thus enabling you to view your progress side-by-side.
+![preview](preview.png)
 
-## Contributing
-
-- Please use the [issues page](https://github.com/SublimeText/BetterCoffeeScript/issues) to make requests or report bugs.
-- Please make _pull requests_ to the `master` branch only. ST2 is not supported anymore.
+**This package is for Sublime Text 3+**.
+An old version for Sublime Text 2 is accessible via the [`st2` branch](https://github.com/SublimeText/BetterCoffeeScript/tree/st2).
 
 # Installation
 
-## via Package Control
-
-> This is the recommended installation method.
+### Package Control
 
-If you have [Package Control](https://packagecontrol.io/), you know what to do. If not, well: it's a package manager for Sublime Text 3. Installation guide can be [found here](https://packagecontrol.io/installation).  After installing the package manager:
+The easiest way to install is using [Package Control](https://packagecontrol.io). It's listed as `CoffeeScript`.
 
-* Open the Command Pallete (`ctrl+shift+P` or `cmd+shift+P`).
-* Type "Install Package" and hit return.
-* Type "CoffeeScript" and hit return.
+1. Open `Command Palette` using <kbd>ctrl+shift+P</kbd> or menu item `Tools → Command Palette...`
+2. Choose `Package Control: Install Package`
+3. Find `CoffeeScript` and hit <kbd>Enter</kbd>
 
-## via Source Control
+## Source Control
 
-> If you plan to contribute, then you should install via this method. Otherwise it is recommended that you install the package via Package Control, see above.
+> [!TIP]
+>
+> Only recommended, if contributions to this package are planned.
 
 Sublime stores packages in the following locations:
 
-	Nix: ~/.config/sublime-text-3/packages
-	Mac: ~/Library/Application\ Support/Sublime\ Text\ 3/Packages
-	Win: %APPDATA%\Sublime Text 3\Packages
-
-When using Sublime Text 4 or higher,
-the directory without the "3" (and the preceding separator character)
-will be preferred.
+```sh
+Nix: ~/.config/sublime-text/packages
+Mac: ~/Library/Application\ Support/Sublime\ Text/Packages
+Win: %APPDATA%\Sublime Text\Packages
+```
 
 ### As a repository within the packages directory
 
 Open a Terminal/Console and run the following commands, replacing `PACKAGE_PATH` with the path corresponding to your OS above.
 
-	cd PACKAGE_PATH
-	git clone https://github.com/SublimeText/BetterCoffeeScript.git "CoffeeScript"
+```sh
+cd PACKAGE_PATH
+git clone https://github.com/SublimeText/BetterCoffeeScript.git "CoffeeScript"
+```
 
 ### As a repository outside of the packages directory
 
 If you use Github for Mac/Windows which store repositories in a specific location, or if you just don't want a repository in your packages directory, then instead you can use a link.
 
-If you don't yet have the repository, then grab it via your GUI program or via the command line:
-
-	cd WHEREVER_YOU_WANT
-	git clone https://github.com/SublimeText/BetterCoffeeScript.git
-
-Once that is done, we will create the link:
-
-#### Windows:
-
-	cd PACKAGE_PATH
-	mklink /D "CoffeeScript" ABSOLUTE_PATH_TO_REPOSITORY
-
-#### Nix/Mac:
-
-	cd PACKAGE_PATH
-	ln -s ABSOLUTE_PATH_TO_REPOSITORY "CoffeeScript"
-
+1. Clone the repository via GUI program or command line:
+   
+   ```sh
+   cd WHEREVER_YOU_WANT
+   git clone https://github.com/SublimeText/BetterCoffeeScript.git
+   ```
+
+2. Once that is done, create the link:
+
+   **Windows:**
+   
+   ```sh
+   cd PACKAGE_PATH
+   mklink /D "CoffeeScript" ABSOLUTE_PATH_TO_REPOSITORY
+   ```
+   
+   **Nix/Mac:**
+   
+   ```sh
+   cd PACKAGE_PATH
+   ln -s ABSOLUTE_PATH_TO_REPOSITORY "CoffeeScript"
+   ```
 
 # Commands/Shortcuts
 
@@ -86,8 +86,6 @@ Context menu has `Compile Output` that compiles the current CoffeeScript and out
 
 **Note:** Some of the commands use the Status Bar for output, so you'll probably want to enable it (View » Show Status Bar).
 
-
-
 # Snippets
 
 - Use `TAB` to run a snippet after typing the trigger.
@@ -144,7 +142,7 @@ That's what this is for! You would create a `Cakefile` and inside it you would w
 
 Go to `Preferences > Package Settings > CoffeeScript > Settings - User` to change settings.
 
-```Javascript
+```jsonc
 {
 	/*
 		The directories you would like to include in $PATH environment variable.
@@ -159,34 +157,34 @@ Go to `Preferences > Package Settings > CoffeeScript > Settings - User` to chang
 		The directory containing your coffee binary. Usually
 		/usr/local/bin.
 	*/
-	"binDir": "/usr/local/bin"
+	"binDir": "/usr/local/bin",
 
 	/*
 		Compile without the top-level function wrapper (coffee -b).
 	*/
 
-,	"noWrapper": true
+	"noWrapper": true,
 
 	/*
 		Enable or disable refresh the compiled Output on Save.
 		Only available for watch mode.
 	*/
-,	"watchOnSave": true
+	"watchOnSave": true,
 	/*
 		Enable refreshing compiled JS when CoffeeScript is modified.
 
 		Put false to disable
 		Put a number of seconds to delay the refresh
 	*/
-,	"watchOnModified": 0.5
+	"watchOnModified": 0.5,
 	/*
 		Enable Compiling on save. It will compile into the same folder.
 	*/
-,	"compileOnSave": true
+	"compileOnSave": true,
 	/*
 		## Enable outputting the results of the compiled coffeescript in a panel
 	*/
-,	"showOutputOnSave": false
+	"showOutputOnSave": false,
 	/*
 		## Enable compiling to a specific directory.
 		#### Description
@@ -201,7 +199,7 @@ Go to `Preferences > Package Settings > CoffeeScript > Settings - User` to chang
 			compileDir": "/home/logan/Desktop/out"
 
 	*/
-,	"compileDir": false
+	"compileDir": false,
 	/*
 		## Enable compiling to a specific relative directories.
 
@@ -223,38 +221,27 @@ Go to `Preferences > Package Settings > CoffeeScript > Settings - User` to chang
 			"/home/user/projects/main.coffee" will compile to "/home/user/projects/js/main.js"
 
 	*/
-,	"compilePaths": false
-
-
-
+	"compilePaths": false,
 }
-
-
 ```
 
 ## Project settings
 
 Go to `Project > Edit Project` to change project settings.
 
-```Javascript
+```json
 {
-	"folders":
-	[
-		...
+	"folders": [
+		"."
 	],
-	"settings":
-	{
-		"CoffeeScript":
-		{
+	"settings": {
+		"CoffeeScript": {
 			"noWrapper": true,
 			"compileOnSave": true,
 			"compileDir": "out"
 		}
 	}
 }
-
-
-
 ```
 
 # FAQ
@@ -294,19 +281,3 @@ This path will go into the `binDir` setting.
 - I'm getting the error message `'coffee' is not recognized as an internal or external command,` when saving.
 
 The coffee-script binary probably is not installed. Either install coffee-script or set `checkSyntaxOnSave` and `compileOnSave` to `false` in `Preferences > Package Settings > CoffeeScript > Settings - User`.
-
-
-
-# Latest Changelog
-### v0.7.0 01/June/2013
-
-- merged st3 with master branch
-- now the sublime text 2 support is in st2 branch
-- fixed the @ highlight in language definitions
-- fixed an error you would get when it was looking for project settings when it wasn't a project we were editing
-
-# Special Thanks
-
-
-Thanks to [everyone who has contributed to this project](https://github.com/SublimeText/BetterCoffeeScript/graphs/contributors).
-You guys rock!

logo.svg

@@ -0,0 +1,30 @@
+# Assignment:
+number   = 42
+opposite = true
+
+# Conditions:
+number = -42 if opposite
+
+# Functions:
+square = (x) -> x * x
+
+# Arrays:
+list = [1, 2, 3, 4, 5]
+
+# Objects:
+math =
+  root:   Math.sqrt
+  square: square
+  cube:   (x) -> x * square x
+
+# Splats:
+race = (winner, runners...) ->
+  print winner, runners
+
+# Array comprehensions:
+cubes = (math.cube num for num in list)
+
+# Existence:
+alert "I knew it!" if elvis?
+
+