summaryrefslogtreecommitdiff
path: root/README.md
blob: d1eadacecdfe840ff987d0ae0102bf7485449f95 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
# Hutch for Sourcehut
Sourcehut on iOS

[![builds.sr.ht status](https://builds.sr.ht/~ccleberg/Hutch.svg)](https://builds.sr.ht/~ccleberg/Hutch?)

## Table of Contents

- [Introduction](#introduction)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)

## Introduction

**Hutch** is a native Swift client on iOS for [Sourcehut](https://sr.ht).

## Installation

To get started with Hutch, follow these steps:

1. Clone the repository: `git clone
   https://git.sr.ht/~ccleberg/Hutch`
2. Open the project in Xcode.
3. Run the app on your device or simulator.

## Usage

Provide instructions on how to use the app. You might include:

- **Step 1**: To login, use a PAT in Sourcehut's portal:
  https://meta.sr.ht/oauth2/personal-token
- **Step 2**: Navigate the app the same way you'd navigate Sourcehut.
- **Step 3**: If something doesn't work as expected, send us an email!

## Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature (`git checkout -b feature-xyz`).
3. Make your changes.
4. Commit your changes and push to the branch.
5. Open a pull request.

## License

This project is licensed under the GPL 3.0 or later License. See the
[LICENSE](LICENSE) file for more information.

## Contact

For questions or feedback, please reach out to [[email protected]].

---

Thank you for checking out **Hutch**! We hope you find it useful and enjoyable.