README.md in turmali-0.0.2 vs README.md in turmali-0.0.3
- old
+ new
@@ -1,9 +1,22 @@
# Turmali
+
+
Turmali is a website building language.
+ ▪ As in Python, blocks of code are delimited by their indentation.
+ ▪ Classes are declared with the class keyword.
+ ▪ Methods can be defined anywhere using the def keyword.
+ ▪ Identifiers starting with a capital letter are constants which are globally accessible.
+ ▪ Lower-case identifiers are local variables or method names.
+ ▪ If a method has a receiver and no argument, parenthesis can be skipped, much like in Ruby. Eg.: self.print is the same as self.print().
+ ▪ The last value evaluated in a method is its return value.
+ ▪ Everything is an object.
+
+## Example
+
```
class Turmali:
def name:
"I'm Turmali"
def turmali:
@@ -31,27 +44,11 @@
$ gem install turmali
## Usage
-```The Turmali language!
-
- usage:
- ./tml example.tml # to eval a file
- ./tml # to start the REPL
-
- on Windows run with: ruby -I. tml [options]
-```
-
-## Development
-
-After checking out the repo, run `rake spec` to run the tests. You can also run `bin/tml` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/eiffelqiu/turmali. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+ $ tml example.tml
+ $ tml # on Windows run with: ruby -I. tml [options]
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).