Skip to content

Commit 05700f0

Browse files
authored
Merge pull request #14 from fummicc1/docs/update-docc
Update docs
2 parents 6d18bfd + ced60dc commit 05700f0

2,952 files changed

Lines changed: 3249 additions & 1627 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<img src="https://github.com/fummicc1/AsyncDownSamplingImage/assets/44002126/254ee84d-1e08-4a61-b507-8f78f2e1d6d3" width="320px">
66

7-
# Impact of Downsampling
7+
## Impact of Downsampling
88

99
with downsampling, we can reduce the huge amount of memory use like the below.
1010

@@ -26,11 +26,13 @@ With AsyncDownSamplingImage, we changed Image size `1000x1000` into `160x160` wh
2626
|---|---|
2727
|<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">|
2828

29+
## Installation
2930

31+
```swift
32+
.package(url: "https://github.com/fummicc1/AsyncDownSamplingImage.git", from: "1.1.0")
33+
```
3034

31-
32-
33-
# How to use AsyncDownSamplingImage
35+
## How to use AsyncDownSamplingImage
3436

3537
`AsyncDownSamplingImage` aims to be used in a similar way to `AsyncImage` even if the implementation is different.
3638

@@ -82,20 +84,29 @@ AsyncDownSamplingImage(
8284
}
8385
```
8486

85-
# DocC
87+
## How to use IncrementalImage
8688

87-
[Documentation](https://fummicc1.github.io/AsyncDownSamplingImage/documentation/asyncdownsamplingimage/) generated by DocC is available (still working in progress).
89+
IncrementalImage is a component that can load image data in chunks.
90+
The size of buffer is set by `bufferSize` parameter in bytes unit.
8891

92+
```swift
93+
let url = URL(string: "https://via.placeholder.com/1000")
94+
95+
IncrementalImage(url: url, bufferSize: 1 * 1024)
96+
```
8997

98+
## DocC
99+
100+
[Documentation](https://fummicc1.github.io/AsyncDownSamplingImage/documentation/asyncdownsamplingimage/) generated by DocC is available (still working in progress).
90101

91-
# Contributing
102+
## Contributing
92103

93104
Pull requests, bug reports and feature requests are welcome 🚀
94105

95-
# License
106+
## License
96107

97108
[MIT LICENSE](https://github.com/fummicc1/AsyncDownSamplingImage/blob/main/LICENSE)
98109

99-
# Reference
110+
## Reference
100111

101112
- https://medium.com/@zippicoder/downsampling-images-for-better-memory-consumption-and-uicollectionview-performance-35e0b4526425

docs/css/866.60f074fd.css

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/css/989.4f123103.css

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/css/chunk-c0335d80.10a2f091.css

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/css/documentation-topic.1d1eec04.css

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/css/documentation-topic.91c07ba9.css

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/css/documentation-topic~topic.b6287bcf.css

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/css/documentation-topic~topic~tutorials-overview.d6f5411c.css

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/css/index.038e887c.css

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/css/index.3a335429.css

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)