blob: 95d8895e7d314026f919463880075029da40748a (
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
# Hutch
<div style="display: flex; align-items: center; border: 1px solid #ccc; border-radius: 10px; padding: 10px; width: 300px; background-color: #f9f9f9;">
<img src="https://img.cleberg.net/apps/hutch/logo/hutch_light.png" alt="Hutch App Logo" style="border-radius: 50%; width: 60px; height: 60px; margin-right: 10px;">
<div>
<h2 style="margin: 0; font-size: 20px; color: #333;">Hutch</h2>
<h3 style="margin: 0; font-size: 14px; color: #777;">An iOS client for Sourcehut</h3>
</div>
</div>
![Hutch App Logo]()
## Table of Contents
- [Introduction](#introduction)
<!-- - [Features](#features)
- [Screenshots](#screenshots) -->
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
## Introduction
**Hutch** is a native Swift client on iOS for [Sourcehut](https://sr.ht).
<!-- TODO
## Features
- **Seamless Integration**: Effortlessly connect to your sr.ht account.
- **Repository Access**: View and manage your repositories in one convenient
location.
- **Ticket Management**: Create and track tickets associated with your projects.
- **Profile Management**: Update your account description, keys, and
preferences.
For a complete list of features, visit [here](http://example.com/features).
## Roadmap
- **Build Notifications**: Get real-time updates on your builds and status
changes.
- **Dashboard Access**: View and manage your projects in one convenient
location.
To see future planned features and updates, check out the project roadmap
[here](http://example.com/roadmap).
## Screenshots
Here are some screenshots of the app in action:
-->
## Installation
To get started with Hutch, follow these steps:
1. Clone the repository: `git clone
https://github.com/ccleberg/Hutch.git`
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.
|
