Skip to content

Commit eafcce6

Browse files
committed
Add contribution steps for working with lib
1 parent f3755b4 commit eafcce6

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

+15
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,21 @@ AIProxy as an alternative to building, monitoring, and maintaining your own back
8080
tree and select 'Update Package'.
8181

8282

83+
## How to contribute to the package
84+
85+
Your additions to AIProxySwift are welcome! I like to develop the library while working in an
86+
app that depends on it:
87+
88+
1. Fork the repo
89+
2. Clone your fork
90+
3. Open your app in Xcode
91+
4. Remove AIProxySwift from your app (since this is likely referencing a remote lib)
92+
5. Go to `File > Add Package Dependencies`, and in the bottom left of that popup there is a button "Add local"
93+
6. Tap "Add local" and then select the folder where you cloned AIProxySwift on your disk.
94+
95+
If you do that, then you can modify the source to AIProxySwift right from within your Xcode project for your app.
96+
Once you're happy with your changes, open a PR here.
97+
8398
# Example usage
8499

85100
Along with the snippets below, which you can copy and paste into your Xcode project, we also

0 commit comments

Comments
 (0)