diff --git a/README.md b/README.md index 9c8b626..66cabfc 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,44 @@ -# Revolt iOS +
+

+ Revolt iOS + + [![Stars](https://img.shields.io/github/stars/revoltchat/ios?style=flat-square&logoColor=white)](https://github.com/revoltchat/ios/stargazers) + [![Forks](https://img.shields.io/github/forks/revoltchat/ios?style=flat-square&logoColor=white)](https://github.com/revoltchat/ios/network/members) + [![Pull Requests](https://img.shields.io/github/issues-pr/revoltchat/ios?style=flat-square&logoColor=white)](https://github.com/revoltchat/ios/pulls) + [![Issues](https://img.shields.io/github/issues/revoltchat/ios?style=flat-square&logoColor=white)](https://github.com/revoltchat/ios/issues) + [![Contributors](https://img.shields.io/github/contributors/revoltchat/ios?style=flat-square&logoColor=white)](https://github.com/revoltchat/ios/graphs/contributors) + [![License](https://img.shields.io/github/license/revoltchat/ios?style=flat-square&logoColor=white)](https://github.com/revoltchat/ios/blob/main/LICENSE) +

+Native iOS app for Revolt +
+
-iOS app +This repository contains the source code for the native iOS application. + +> [!IMPORTANT] +> This app is still in early stages, and not yet ready for production. + +## Development + +### Getting Started + +Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes. + +#### Prerequisites + +- macOS with Xcode installed. + +#### Installation + +1. **Clone the repository:** \ + `git clone https://github.com/revoltchat/ios.git` + +2. **Open the project in Xcode:** \ + Open `Revolt.xcworkspace` in Xcode. + +3. **Build and run the app:** \ + Select your target device or simulator and hit the run button. + +## License + +All content contained within this repository is licensed under the [GNU Affero General Public License v3.0](https://github.com/revoltchat/ios/blob/main/LICENSE). Dependencies may be licensed differently._