Add docs

Author: cyradin

README.md

@@ -1 +1,32 @@
-# spellchecker-web
+# spellchecker-web
+
+`spellchecker-web` is a Go-based ready-to-use spellchecker web service. It leverages [f1monkey/spellchecker](https://github.com/f1monkey/spellchecker) as its core for spell checking and correction, supports multiple dictionaries and has an autosave feature.
+
+## Configuration
+
+Before running the service, set the following environment variables:
+
+|Variable        | 	Description | Example |
+|----------------|------------- |---------|
+|SPELLCHECKER_DIR| 	Directory to store dictionaries |	/tmp/spellchecker |
+|SPELLCHECKER_AUTOSAVE_INTERVAL| 	Auto-save interval (Go time.Duration) | 5m |
+|HTTP_ADDR| 	HTTP server address and port | localhost:8011 |
+|LOG_LEVEL| 	Logging level |	info, debug |
+
+## Swagger Docs
+
+The OpenAPI (Swagger) documentation is available at /docs.
+
+## Usage Example
+
+1) Create a dictionary:
+
+```
+POST /v1/dictionaries/{code}
+Content-Type: application/json
+
+{
+  "alphabet": "abcdefghijklmnopqrstuvwxyz",
+  "maxErrors": 2
+}
+```