add README.md

.github/workflows/ci.yml

@@ -28,3 +28,4 @@ jobs:
           ls -la ~/.gradle/gradle.properties
           cat ~/.zshrc.example
           cat ~/.gradle/gradle.properties
+          envhub status

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2024 Tsiry Sandratraina <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,15 @@
+# Dotfiles Example
+
+[![dotfiles example](https://github.com/tsirysndr/dotfiles-example/actions/workflows/ci.yml/badge.svg)](https://github.com/tsirysndr/dotfiles-example/actions/workflows/ci.yml)
+
+This is a minimal example of how to use dotfiles with [Envhub CLI](https://github.com/tsirysndr/envhub).
+
+## 🚚 Installation
+
+```sh
+envhub use tsirysndr/dotfiles-example
+```
+
+## 📝 License
+
+[MIT](LICENSE)