diff --git a/README.md b/README.md index 0a4d265..b53c229 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,37 @@ Neuron is a language that compiles directly into HTML, CSS, and JavaScript. Neuron is currently under heavy development. -[Documentation](https://neuron-lang.readthedocs.io/en/master/) +### [Documentation](https://neuron-lang.readthedocs.io/en/master/) +### [Getting Started with Neuron](https://neuron-lang.readthedocs.io/en/master/getting-started.html) + +### Neuron Language: +```javascript +image { + tag: img; + src: path/to/image; + fill: [math.abs => -10] 0 0 0; + log(this.fill); +} + +invoke(image); +``` +### Comparative JavaScript (and HTML): +```html + + + + + +``` + ## Installation Install Neuron with `npm`: ``` @@ -29,27 +59,3 @@ Use Neuron in the browser through its web framework: Packages with JavaScript bindings are written in the JSON format. See [`lib/packages/reference.json`](https://github.com/underpig1/neuron-lang/blob/master/lib/packages/reference.json) for an example. To help extensify Neuron's standard library, submit a Pull Request with the appended package in the `lib/packages` folder. - -## Command Line -Install Neuron with `npm`: -``` -npm install -g neuron-lang -``` -Neuron can then be used in the Command Line as such: `neuron myFile.neuron` - -## Browser Support -Neuron can be used in the browser through its web framework: -```html - - -``` -### Support -| | Chrome | Edge | Firefox | IE | Safari | Command Line | -| ------------- | ------------- | ------------- | ------------- | ------------- | ------------- | ------------- | -| Window API | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: | -| Time API | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | -| RegExp API | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | -| JSON API | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | -| Math API | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_exclamation_mark: | :heavy_check_mark: | :heavy_check_mark: |