diff --git a/README.md b/README.md index e594e72..7b915ec 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,20 @@ # Cosmo [![AppVeyor](https://ci.appveyor.com/api/projects/status/github/CPunch/Cosmo?svg=true)](https://ci.appveyor.com/project/CPunch/Cosmo) +## Usage + +``` +Usage: ./bin/cosmo [-clsr] [args] + +available options are: +-c compile and dump to +-l load dump from +-s compile and run script(s) +-r start the repl +``` + +## What is a 'cosmo'? + Cosmo is a portable scripting language loosely based off of Lua. Cosmo easily allows the user to extend the language through the use of Proto objects, which describe the behavior of Objects. For example the following is a simple Vector Proto which describes behavior for a Vector-like object. ```lua @@ -39,7 +53,4 @@ end 2 : 1 1 : 2 0 : 3 -``` - -# C API -The Cosmo C API is currently undocumented, however as soon as development has reached a stable state documentation on full language features and the C API will start. \ No newline at end of file +``` \ No newline at end of file