Skip to content

Commit 242085c

Browse files
committed
add TOC to README
1 parent 293f96f commit 242085c

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ New features:
1414
mirror the expiry timestamp to the target side. The `jobs[].expiration` configuration section can be used to control
1515
this behavior.
1616

17+
Changes:
18+
- The code has been restructured for better extensibility and high-level readability.
19+
- The README has been restructured to be less chaotic, and a TOC has been added for better discoverability.
20+
1721
Bugfixes:
1822
- Interrupts (SIGTERM and SIGINT) are now ignored less often.
1923

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# swift-http-import
22

3+
* [Implicit assumptions](#implicit-assumptions)
4+
* [Installation](#installation)
5+
* [Usage](#usage)
6+
** [Source specification](#source-specification)
7+
** [File selection](#file-selection)
8+
** [Transfer behavior: Segmenting](#transfer-behavior-segmenting)
9+
** [Transfer behavior: Expiring objects](#transfer-behavior-expiring-objects)
10+
** [Performance](#performance)
11+
* [Log output](#log-output)
12+
* [StatsD metrics](#statsd-metrics)
13+
314
This tool imports files from an HTTP server into a Swift container. Given an input URL, it recurses through the directory
415
listings on that URL, and mirrors all files that it finds into Swift. It will take advantage of `Last-Modified` and
516
`Etag` response headers to avoid repeated downloads of the same content, so best performance is ensured the HTTP server

0 commit comments

Comments
 (0)