summaryrefslogtreecommitdiff
path: root/docs/index.md
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2021-08-17 11:41:50 -0400
committerJordan Wiens <jordan@psifertex.com>2021-08-17 11:41:50 -0400
commit401b73b242bc9447bd12215b17ea8ce215c7d6ed (patch)
tree58307b57c435d48e17f0b382cf26beb4bde601b4 /docs/index.md
parent6312556eede2d80978f7f77ce8757f5290d5a900 (diff)
add more general API documentation and numerous other documentation improvements
Diffstat (limited to 'docs/index.md')
-rw-r--r--docs/index.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/docs/index.md b/docs/index.md
index 473d7290..6bcf6fb3 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -4,6 +4,9 @@ A new kind of reverse engineering platform
---
-[Binary Ninja] is a reverse engineering platform. It focuses on a clean and easy to use interface with a powerful multithreaded analysis built on a custom IL to quickly adapt to a variety of architectures, platforms, and compilers.
+[Binary Ninja](https://binary.ninja/) is a reverse engineering platform. It focuses on a clean and easy to use interface with a powerful multithreaded analysis built on a custom IL to quickly adapt to a variety of architectures, platforms, and compilers.
-[Binary Ninja]: https://binary.ninja/
+The most common starting points for documentation are:
+
+- [Getting Started Guide](getting-started.md)
+- [API documentation](dev/api.md) (depending on your language of choice)