Create README.md
This commit is contained in:
1 parent
24a2b22123
commit
378da92ec6
1 file changed
+28
@@ -0,0 +1,28 @@
|
||||
# CatProject
|
||||
|
||||
> [!Note]
|
||||
> This was an educational project and is no longer under any development. The repository is archived.
|
||||
|
||||
## Overview
|
||||
|
||||
CatProject is a simple iOS application that fetches random silly cat images using the Cat as a Service (catass) API.
|
||||
The app features two main view controllers that allow users to generate plain cat images or with a custom text overlay.
|
||||
|
||||
## Functionality
|
||||
|
||||
- **PlainCatViewController**: This view controller displays a random cat image when the user taps the "Generate Cat" button.
|
||||
|
||||
- **TextedCatViewController**: This view controller allows users to input custom text. When the "Generate Cat" button is tapped, it fetches a cat image with the specified text overlay.
|
||||
|
||||
## Notes
|
||||
|
||||
- The app uses the `fetchCat` function to make network requests to the catass API. The function constructs the appropriate URL based on whether custom text is provided or not.
|
||||
- The README was generated by [GPT-4o of OpenAI](https://openai.com/index/hello-gpt-4o/), since I wasn't particularly invested in putting much effort into this project anymore.
|
||||
|
||||
## Acknowledgments
|
||||
|
||||
Special thanks to the [Cat as a Service (catass)](https://cataas.com/) API for providing the delightful cat images that power this application.
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the [Unlicense](./LICENSE).
|
||||
Reference in new issue
Block a user