diff --git a/README.md b/README.md index 009e812a..7a679121 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ -selene is a modern Lua linter. +# selene + +## [Read the documentation here!](https://kampfkarren.github.io/selene/) + +selene is a blazing-fast modern Lua linter written in Rust. Priorities: - It's okay to not diagnose every problem, as long as the diagnostics that are made are never wrong - Easy to extend and modify - Easy to configure - ...but the user should need to configure as little as possible - -TODO: Write a good README