From e69b35ee2da8c97df1cc8fee1c2442acf7dff60b Mon Sep 17 00:00:00 2001 From: Kampfkarren Date: Wed, 6 Nov 2019 02:55:31 -0800 Subject: [PATCH] Update README --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) 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