Просмотр исходного кода

Write the getting started index

onevcat 2 лет назад
Родитель
Сommit
bbbf700b3f

+ 33 - 4
Sources/Documentation.docc/GettingStarted.md

@@ -9,10 +9,39 @@ Installs Kingfisher to your project, setup everything and some starter examples
 
 
 ## Overview
 ## Overview
 
 
-<!--@START_MENU_TOKEN@-->Text<!--@END_MENU_TOKEN@-->
+Kingfisher is designed to facilitate the downloading and caching of remote images in the simplest way possible. 
+As such, the basic usage of Kingfisher is straightforward. We offer two step-by-step tutorials to help you understand 
+and utilize Kingfisher's fundamental features in both UIKit and SwiftUI environments. The tutorials will cover the 
+following aspects:
 
 
-@Image(source: "", alt: "Hello this is not what we want")
+#### 􀈅 Installing Kingfisher
+Learn how to integrate Kingfisher into your project setup.
 
 
-### Section header
+#### 􀏆 Loading and Displaying Images
+Discover how to effortlessly fetch and display images from remote URLs using convenient view extensions.
 
 
-Hfasd
+#### 􀙅 Processing Images with ImageProcessor
+
+Understand how to manipulate and transform images using the ImageProcessor functionality.
+
+#### 􀤃 Inspecting and Managing Image Cache
+
+Gain insights into how to check the image cache status and handle image caching.
+
+## Tutorials
+
+By following these tutorials, you will acquire a preliminary understanding of Kingfisher, laying the groundwork for 
+potential advanced usage in the future.
+
+Choose the approach you prefer to begin the tutorial (UIKit or SwiftUI):
+
+@Links(visualStyle: list) {
+    - <doc:GettingStartedUIKit>
+    - <doc:GettingStartedSwiftUI>
+}
+
+>tip: In addition to UIKit and SwiftUI, Kingfisher also offers support for use in AppKit. This extends Kingfisher's 
+> versatility across different Apple platforms, providing a unified API for handling remote images.
+>
+> If you are interested in utilizing Kingfisher within an AppKit context, we recommend referring to the UIKit 
+> tutorials as a starting point. Most of the concept, even the APIs, are shared.

+ 29 - 0
Sources/Documentation.docc/Tutorials/GettingStartedSwiftUI.tutorial

@@ -0,0 +1,29 @@
+@Tutorial(time: 15) {
+    @Intro(title: "Getting Started with Kingfisher (SwiftUI)") {
+        Installs Kingfisher and basic usage of the framework with SwiftUI.
+        
+        @Image(source: <#file#>, alt: "<#accessible description#>")
+    }
+    
+    @Section(title: "<#text#>") {
+        @ContentAndMedia {
+            <#text#>
+            
+            @Image(source: <#file#>, alt: "<#accessible description#>")
+        }
+        
+        @Steps {
+            @Step {
+                <#text#>
+                
+                @Image(source: <#file#>, alt: "<#accessible description#>")
+            }
+            
+            @Step {
+                <#text#>
+                
+                @Code(name: "<#display name#>", file: <#filename.swift#>)
+            }
+        }
+    }
+}

+ 2 - 2
Sources/Documentation.docc/Tutorials/GettingStartedUIKit.tutorial

@@ -1,6 +1,6 @@
 @Tutorial(time: 15) {
 @Tutorial(time: 15) {
-    @Intro(title: "Getting Started with Kingfhser") {
-        Installs Kingfisher to your project, setup everything and some starter examples of the core functionality.
+    @Intro(title: "Getting Started with Kingfisher (UIKit)") {
+        Installs Kingfisher and basic usage of the framework with UIKit.
         
         
         @Image(source: "getting-started-card", alt: "")
         @Image(source: "getting-started-card", alt: "")
     }
     }