misc: make a simple README

jumanji144 · Dec 15, 2023 · af00ca2 · af00ca2
1 parent a5b7c79
commit af00ca2
Show file tree

Hide file tree

Showing 4 changed files with 225 additions and 154 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,10 @@
-[![forthebadge](https://forthebadge.com/images/badges/contains-tasty-spaghetti-code.svg)](https://forthebadge.com)
 # Jasm
 
 Jasm is a Java and Dalvik (coming soon™) assembler suit.
+
+## Usage
+To use Jasm, you can either use the CLI or integrate it into your application.
+
+For usage on the CLI, see [docs/usage/Cli.md](docs/usage/Cli.md).
+
+For language reference, see [docs/language/Basics.md](docs/language/Basics.md). and [docs/language/Syntax.md](docs/language/Syntax.md).