add readme

Author: abreujp

.gitignore

@@ -7,9 +7,11 @@
 /.idea/workspace.xml
 /.idea/navEditor.xml
 /.idea/assetWizardSettings.xml
+.idea/
 .DS_Store
 /build
 /captures
 .externalNativeBuild
 .cxx
 local.properties
+app/build/

README.md

@@ -0,0 +1,34 @@
+# HexReader
+
+Offline HexDocs reader for Android. Browse and download [Hex.pm](https://hex.pm) documentation for offline reading.
+
+## Features
+
+- Search and download documentation from any Hex.pm package
+- One-tap download of official Elixir language documentation
+- Offline reading — no internet required after download
+- Clean, Material 3 design
+
+## Screenshots
+
+*Coming soon*
+
+## Download
+
+Get the latest APK from [Releases](../../releases).
+
+Minimum Android version: **8.0** (API 26)
+
+## How it works
+
+HexReader mirrors HTML documentation from [hexdocs.pm](https://hexdocs.pm) and stores it locally. The app downloads HTML pages, CSS, and referenced assets, allowing full offline browsing.
+
+## Built with
+
+- Kotlin
+- Jetpack Compose + Material 3
+- OkHttp
+
+## License
+
+MIT