Commit acec892

mo khan <mo@mokhan.ca>
2025-04-17 16:43:31
docs: improve the project README
1 parent d2498e0
Changed files (1)
README.md
@@ -1,3 +1,52 @@
-# x
+# Experimental Packages
 
-[![CI](https://github.com/xlgmokha/x/actions/workflows/ci.yml/badge.svg)](https://github.com/xlgmokha/x/actions/workflows/ci.yml)
+**x** is a project designed to make Go a little easier to work with.
+
+## Getting Started
+
+### Prerequisites
+
+- [mise](https://mise.jdx.dev/)
+- [make](https://www.gnu.org/software/make/)
+
+### Installation
+
+1. Clone the repository:
+
+   ```bash
+   $ git clone git@github.com:xlgmokha/x.git
+   ```
+
+2. Navigate to the project directory:
+   ```bash
+   $ cd x
+   ```
+
+3. Install the tools:
+
+   ```bash
+   $ make setup
+   ```
+
+4. Run the test suite:
+
+   ```bash
+   $ make test
+   ```
+
+## Project Structure
+
+- `cmd/`: Contains the executables for this project.
+- `pkg/`: Library code that's safe to use by external applications.
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.
+
+## License
+
+This project is licensed under the [MIT License](./LICENSE).
+
+## Contact
+
+For questions or suggestions, please contact @xlgmokha.