krz/hutch

 1# Hutch for Sourcehut
 2Sourcehut on iOS
 3
 4[![builds.sr.ht status](https://builds.sr.ht/~ccleberg/Hutch.svg)](https://builds.sr.ht/~ccleberg/Hutch?)
 5
 6## Table of Contents
 7
 8- [Introduction](#introduction)
 9- [Installation](#installation)
10- [Usage](#usage)
11- [Contributing](#contributing)
12- [License](#license)
13- [Contact](#contact)
14
15## Introduction
16
17**Hutch** is a native Swift client on iOS for [Sourcehut](https://sr.ht).
18
19## Installation
20
21To get started with Hutch, follow these steps:
22
231. Clone the repository: `git clone
24   https://git.sr.ht/~ccleberg/Hutch`
252. Open the project in Xcode.
263. Run the app on your device or simulator.
27
28## Usage
29
30Provide instructions on how to use the app. You might include:
31
32- **Step 1**: To login, use a PAT in Sourcehut's portal:
33  https://meta.sr.ht/oauth2/personal-token
34- **Step 2**: Navigate the app the same way you'd navigate Sourcehut.
35- **Step 3**: If something doesn't work as expected, send us an email!
36
37## Contributing
38
39Contributions are welcome! Please follow these steps:
40
411. Fork the repository.
422. Create a new branch for your feature (`git checkout -b feature-xyz`).
433. Make your changes.
444. Commit your changes and push to the branch.
455. Open a pull request.
46
47## License
48
49This project is licensed under the GPL 3.0 or later License. See the
50[LICENSE](LICENSE) file for more information.
51
52## Contact
53
54For questions or feedback, please reach out to [hello@cleberg.net].
55
56---
57
58Thank you for checking out **Hutch**! We hope you find it useful and enjoyable.