Update docs

LorisSigrist · Oct 3, 2023 · f1ca37f · f1ca37f
1 parent 508ab26
commit f1ca37f
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,22 @@
 # t18s
 
-Typesafe i18n for SvelteKit
+`t18s` is a vite plugin designed to work in tandem with SvelteKit to provide a simple and powerful translation experience. It's focus is on performance, bundle size and developer experience.
+
+## Features
+While it is still in early development, it already has some powerful and unique features.
+
+- [x] Full ICU MessageFormat support
+- [x] Fully TypeSafe
+- [x] HMR: No page reload on translation changes
+- [x] Precompiled translations, no runtime overhead
+- [x] Supports SSR and Prerendering
+
+## Documentation
+- [Introduction](docs/10-Introduction.md)
+- [Getting Started](docs/20-Getting-Started.md)
+- [Usage](docs/30-Usage.md)
+- [API](docs/40-API.md)
+- [Advanced Usage](docs/50-Advanced-Usage.md)
+- [Precompilation](docs/80-Precompilation.md)
+- [Roadmap](docs/99-Roadmap.md)
+
diff --git a/docs/10-Introduction.md b/docs/10-Introduction.md
@@ -1,3 +1,12 @@
 # Introduction
 
-TODO
+`t18s` is a vite plugin designed to work in tandem with SvelteKit to provide a simple and powerful translation experience. It's focus is on performance, bundle size and developer experience.
+
+
+## Features
+- [x] Fully TypeSafe
+- [x] Precompiled translations, no runtime overhead
+- [x] Supports SSR
+- [x] Full ICU MessageFormat support
+- [x] HMR: No page reload on translation changes
+
diff --git a/docs/40-API.md b/docs/40-API.md
@@ -0,0 +1,3 @@
+# API
+
+TODO
diff --git a/docs/50-Advanced-Loading.md → docs/50-Advanced-Usage.md b/docs/50-Advanced-Loading.md → docs/50-Advanced-Usage.md