Skip to content

Commit 8c41b00

Browse files
committed
added Hook's Cheat Sheet to README.md
1 parent 38f4a25 commit 8c41b00

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ Hook is a simple, cross-platform, dynamically typed scripting language that util
99

1010
> **Note**: Hook is currently in the early stages of development and should not be used in production environments at this time.
1111
12-
## What does it look like
12+
## What does it look like?
1313

14-
Hook features a modern syntax similar to C. For examples:
14+
Hook features a modern syntax similar to C.
1515

1616
```rust
1717
fn factorial(n) {
@@ -73,7 +73,14 @@ hook -e 'println("Hello, world!");'
7373

7474
## Documentation
7575

76-
Unfortunately, as the language is undergoing constant updates and changes to its lexemes and syntax, documentation is not currently available. The `examples` folder may provide some guidance in the meantime.
76+
Unfortunately, as the language undergoes constant breaking changes, it's impractical to have complete documentation. However, we have some text files and examples that can help:
77+
78+
* [docs/grammar.md](docs/grammar.md)
79+
* [docs/built-in.md](docs/built-in.md)
80+
* [docs/core-modules.md](docs/core-modules.md)
81+
* [examples](examples)
82+
83+
Additionally, we have a cheatsheet that can be accessed at: [https://cheatsheets.zip/hook](https://cheatsheets.zip/hook)
7784

7885
## Play with Hook online
7986

0 commit comments

Comments
 (0)