Add usage example

Author: samoilyk

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Futured apps s.r.o.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -78,13 +78,36 @@ ${SWIFT_PACKAGES}/GraphQLAPIKit/Resources/apollo-ios-cli generate --path ./Graph
 #### 8. Add GraphQLAPI local package
 - Go to Xcode -> File -> Add Package Dependencies..
 - Choose `Add Local...`
-- Add `GraphQLAPI` as local Swift Package
+- Add `GraphQLAPI` as local Swift Package.
 Make sure, that `GraphQLAPI` library was added to your main's target `Frameworks, Libraries, and Embedded Content` list.
 For your project's test target add `GraphQLAPIMocks` library if necessary.
 
 #### 9. Update `.gitignore` file
 Add `*.graphql.swift` to your repository's git ignore file to ignore Apollo generated code.
-*!Content of generated `Schema` folder has to be commited to the repository!*
+
+**Content of generated `Schema` folder has to be commited to the repository**
 
 #### 10. Exclude `GraphQLAPI` folder from your linter's rule if necessary
 
+## Usage
+
+### Defining Query or Mutation
+```swift
+let query = MyExampleQuery()
+let mutation = MyExampleMutation()
+```
+
+### Fetching the query/perform mutation
+```swift
+let apiAdapter = GraphQLAPIAdapter(url: URL("https://MyAPIUrl.com")!)
+let queryResult = await apiAdapter.fetch(query: query)
+let mutationResult = await apiAdapter.perform(mutation: mutation)
+```
+
+## Contributors
+
+- [Ievgen Samoilyk](https://github.com/samoilyk), <[email protected]>.
+
+## License
+
+GraphQLAPIKit is available under the MIT license. See the [LICENSE file](LICENSE) for more information.