Merge pull request #14 from fummicc1/docs/update-docc

Update docs
fummicc1 · Oct 16, 2024 · 05700f0 · 05700f0
2 parents 6d18bfd + ced60dc
commit 05700f0
Show file tree

Hide file tree

Showing 2,952 changed files with 3,249 additions and 1,627 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 
 <img src="https://github.com/fummicc1/AsyncDownSamplingImage/assets/44002126/254ee84d-1e08-4a61-b507-8f78f2e1d6d3" width="320px">
 
-# Impact of Downsampling
+## Impact of Downsampling
 
 with downsampling, we can reduce the huge amount of memory use like the below.
 
@@ -26,11 +26,13 @@ With AsyncDownSamplingImage, we changed Image size `1000x1000` into `160x160` wh
 |---|---|
 |<img width="480" alt="Screenshot 2023-02-06 at 1 08 46" src="https://user-images.githubusercontent.com/44002126/216831204-06a8dc04-6bd6-44df-8134-290f150abca0.png">|<img width="480" alt="Screenshot 2023-02-06 at 1 07 29" src="https://user-images.githubusercontent.com/44002126/216831199-c5a66b8e-fc1a-4131-a5c5-2f7d57b17a1b.png">|
 
+## Installation
 
+```swift
+.package(url: "https://github.com/fummicc1/AsyncDownSamplingImage.git", from: "1.1.0")
+```
 
-
-
-# How to use AsyncDownSamplingImage
+## How to use AsyncDownSamplingImage
 
 `AsyncDownSamplingImage` aims to be used in a similar way to `AsyncImage` even if the implementation is different.
 
@@ -82,20 +84,29 @@ AsyncDownSamplingImage(
 }
 ```
 
-# DocC
+## How to use IncrementalImage
 
-[Documentation](https://fummicc1.github.io/AsyncDownSamplingImage/documentation/asyncdownsamplingimage/) generated by DocC is available (still working in progress).
+IncrementalImage is a component that can load image data in chunks.
+The size of buffer is set by `bufferSize` parameter in bytes unit.
 
+```swift
+let url = URL(string: "https://via.placeholder.com/1000")
+
+IncrementalImage(url: url, bufferSize: 1 * 1024)
+```
 
+## DocC
+
+[Documentation](https://fummicc1.github.io/AsyncDownSamplingImage/documentation/asyncdownsamplingimage/) generated by DocC is available (still working in progress).
 
-# Contributing
+## Contributing
 
 Pull requests, bug reports and feature requests are welcome 🚀
 
-# License
+## License
 
 [MIT LICENSE](https://github.com/fummicc1/AsyncDownSamplingImage/blob/main/LICENSE)
 
-# Reference
+## Reference
 
 - https://medium.com/@zippicoder/downsampling-images-for-better-memory-consumption-and-uicollectionview-performance-35e0b4526425
diff --git a/docs/css/866.60f074fd.css b/docs/css/866.60f074fd.css
diff --git a/docs/css/989.4f123103.css b/docs/css/989.4f123103.css
diff --git a/docs/css/chunk-c0335d80.10a2f091.css b/docs/css/chunk-c0335d80.10a2f091.css
diff --git a/docs/css/documentation-topic.1d1eec04.css b/docs/css/documentation-topic.1d1eec04.css
diff --git a/docs/css/documentation-topic.91c07ba9.css b/docs/css/documentation-topic.91c07ba9.css
diff --git a/docs/css/documentation-topic~topic.b6287bcf.css b/docs/css/documentation-topic~topic.b6287bcf.css
diff --git a/docs/css/documentation-topic~topic~tutorials-overview.d6f5411c.css b/docs/css/documentation-topic~topic~tutorials-overview.d6f5411c.css
diff --git a/docs/css/index.038e887c.css b/docs/css/index.038e887c.css
diff --git a/docs/css/index.3a335429.css b/docs/css/index.3a335429.css
diff --git a/docs/css/topic.4be8f56d.css b/docs/css/topic.4be8f56d.css
diff --git a/docs/css/topic.d8c126f3.css b/docs/css/topic.d8c126f3.css
diff --git a/docs/css/tutorials-overview.7942d777.css b/docs/css/tutorials-overview.7942d777.css
diff --git a/docs/css/tutorials-overview.c249c765.css b/docs/css/tutorials-overview.c249c765.css