Update README (#91)

* Update README * Synchronize the two manifest versions * Update CI * Logoify README and API docs --------- Co-authored-by: Gwynne Raskind <[email protected]>
vapor · Dec 20, 2023 · 112d495 · 112d495
1 parent 12ee56f
commit 112d495
Show file tree

Hide file tree

Showing 8 changed files with 128 additions and 40 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,24 @@
+version: 2
+enable-beta-ecosystems: true
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    allow:
+      - dependency-type: all
+    groups:
+      dependencies:
+        patterns:
+          - "*"
+  - package-ecosystem: "swift"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    open-pull-requests-limit: 6
+    allow:
+      - dependency-type: all
+    groups:
+      all-dependencies:
+        patterns:
+          - "*"
diff --git a/.github/workflows/api-docs.yml b/.github/workflows/api-docs.yml
@@ -11,4 +11,4 @@ jobs:
      with:
        package_name: multipart-kit
        modules: MultipartKit
-       pathsToInvalidate: /multipartkit
+       pathsToInvalidate: /multipartkit/*
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -6,5 +6,3 @@ on:
 jobs:
   unit-tests:
     uses: vapor/ci/.github/workflows/run-unit-tests.yml@reusable-workflows
-    with:
-      with_coverage: false
diff --git a/Package.swift b/Package.swift
@@ -13,15 +13,23 @@ let package = Package(
         .library(name: "MultipartKit", targets: ["MultipartKit"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/apple/swift-nio.git", from: "2.2.0"),
-        .package(url: "https://github.com/apple/swift-collections.git", from: "1.0.2")
+        .package(url: "https://github.com/apple/swift-nio.git", from: "2.61.1"),
+        .package(url: "https://github.com/apple/swift-collections.git", from: "1.0.5"),
     ],
     targets: [
-        .target(name: "MultipartKit", dependencies: [
-            .product(name: "NIO", package: "swift-nio"),
-            .product(name: "NIOHTTP1", package: "swift-nio"),
-            .product(name: "Collections", package: "swift-collections")
-        ]),
-        .testTarget(name: "MultipartKitTests", dependencies: ["MultipartKit"]),
+        .target(
+            name: "MultipartKit",
+            dependencies: [
+                .product(name: "NIO", package: "swift-nio"),
+                .product(name: "NIOHTTP1", package: "swift-nio"),
+                .product(name: "Collections", package: "swift-collections"),
+            ]
+        ),
+        .testTarget(
+            name: "MultipartKitTests",
+            dependencies: [
+                .target(name: "MultipartKit"),
+            ]
+        ),
     ]
 )
diff --git a/[email protected] b/[email protected]
@@ -14,20 +14,28 @@ let package = Package(
     ],
     dependencies: [
         .package(url: "https://github.com/apple/swift-nio.git", from: "2.61.1"),
-        .package(url: "https://github.com/apple/swift-collections.git", from: "1.0.5")
+        .package(url: "https://github.com/apple/swift-collections.git", from: "1.0.5"),
     ],
     targets: [
         .target(
             name: "MultipartKit",
             dependencies: [
                 .product(name: "NIO", package: "swift-nio"),
                 .product(name: "NIOHTTP1", package: "swift-nio"),
-                .product(name: "Collections", package: "swift-collections")
+                .product(name: "Collections", package: "swift-collections"),
             ],
-            swiftSettings: [.enableExperimentalFeature("StrictConcurrency")]),
+            swiftSettings: [
+                .enableExperimentalFeature("StrictConcurrency=complete"),
+            ]
+        ),
         .testTarget(
             name: "MultipartKitTests",
-            dependencies: ["MultipartKit"],
-            swiftSettings: [.enableExperimentalFeature("StrictConcurrency")]),
+            dependencies: [
+                .target(name: "MultipartKit"),
+            ],
+            swiftSettings: [
+                .enableExperimentalFeature("StrictConcurrency=complete"),
+            ]
+        ),
     ]
 )
diff --git a/README.md b/README.md
@@ -1,30 +1,22 @@
 <p align="center">
-    <img src="https://user-images.githubusercontent.com/1049951/105351980-94fe4280-5bed-11eb-876e-ae60df0f41f0.png" height="64" alt="Multipart">
-    <br>
-    <br>
-    <a href="https://docs.vapor.codes/4.0/">
-        <img src="http://img.shields.io/badge/read_the-docs-2196f3.svg" alt="Documentation">
-    </a>
-    <a href="https://discord.gg/vapor">
-        <img src="https://img.shields.io/discord/431917998102675485.svg" alt="Team Chat">
-    </a>
-    <a href="LICENSE">
-        <img src="http://img.shields.io/badge/license-MIT-brightgreen.svg" alt="MIT License">
-    </a>
-    <a href="https://github.com/vapor/multipart-kit/actions/workflows/test.yml">
-        <img src="https://github.com/vapor/multipart-kit/actions/workflows/test.yml/badge.svg" alt="Continuous Integration">
-    </a>
-    <a href="https://swift.org">
-        <img src="http://img.shields.io/badge/swift-5.4-brightgreen.svg" alt="Swift 5.4">
-    </a>
-    <a href="https://twitter.com/codevapor">
-        <img src="https://img.shields.io/badge/twitter-codevapor-5AA9E7.svg" alt="Twitter">
-    </a>
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://github.com/vapor/multipart-kit/assets/1130717/4b3aed4e-2b18-4689-80c8-d31ccf169947">
+  <source media="(prefers-color-scheme: light)" srcset="https://github.com/vapor/multipart-kit/assets/1130717/5c60750b-ef11-4137-9f9e-917ebcc49ca6">
+  <img src="https://github.com/vapor/multipart-kit/assets/1130717/5c60750b-ef11-4137-9f9e-917ebcc49ca6" height="96" alt="MultipartKit">
+</picture> 
+<br>
+<br>
+<a href="https://docs.vapor.codes/4.0/"><img src="https://design.vapor.codes/images/readthedocs.svg" alt="Documentation"></a>
+<a href="https://discord.gg/vapor"><img src="https://design.vapor.codes/images/discordchat.svg" alt="Team Chat"></a>
+<a href="LICENSE"><img src="https://design.vapor.codes/images/mitlicense.svg" alt="MIT License"></a>
+<a href="https://github.com/vapor/multipart-kit/actions/workflows/test.yml"><img src="https://img.shields.io/github/actions/workflow/status/vapor/multipart-kit/test.yml?event=push&style=plastic&logo=github&label=test&logoColor=%23ccc" alt="Continuous Integration"></a>
+<a href="https://codecov.io/github/vapor/multipart-kit"><img src="https://img.shields.io/codecov/c/github/vapor/multipart-kit?style=plastic&logo=codecov&label=Codecov&token=yDzzHja8lt"></a>
+<a href="https://swift.org"><img src="https://design.vapor.codes/images/swift57up.svg" alt="Swift 5.7+"></a>
 </p>
 
 🏞 Multipart parser and serializer with `Codable` support for Multipart Form Data.
 
-### Major Releases
+### Installation
 
 The table below shows a list of MultipartKit major releases alongside their compatible NIO and Swift versions. 
 
@@ -37,15 +29,31 @@ The table below shows a list of MultipartKit major releases alongside their comp
 
 Use the SPM string to easily include the dependency in your `Package.swift` file.
 
+Add MultiPartKit to your package dependencies:
+
+```swift
+dependencies: [
+    // ...
+    .package(url: "https://github.com/vapor/multipart-kit.git", from: "4.0.0"),
+]
+```
+
+Add MultiPartKit to your target's dependencies:
+
 ```swift
-.package(url: "https://github.com/vapor/multipart-kit.git", from: ...)
+targets: [
+    .target(name: "MyAppTarget", dependencies: [
+        // ...
+        .product(name: "MultiPartKit", package: "multipart-kit"),
+    ])
+]
 ```
 
 ### Supported Platforms
 
 MultipartKit supports the following platforms:
 
-- All Linux distributions supported by Swift
+- All Linux distributions supported by Swift 5.7+
 - macOS 10.15+
 
 ## Overview

diff --git a/Sources/MultipartKit/Docs.docc/images/vapor-multipartkit-logo.svg b/Sources/MultipartKit/Docs.docc/images/vapor-multipartkit-logo.svg
diff --git a/Sources/MultipartKit/Docs.docc/theme-settings.json b/Sources/MultipartKit/Docs.docc/theme-settings.json
@@ -0,0 +1,21 @@
+{
+  "theme": {
+    "aside": { "border-radius": "6px", "border-style": "double", "border-width": "3px" },
+    "border-radius": "0",
+    "button": { "border-radius": "16px", "border-width": "1px", "border-style": "solid" },
+    "code":   { "border-radius": "16px", "border-width": "1px", "border-style": "solid" },
+    "color": {
+      "multipartkit": "#392048",
+      "documentation-intro-fill":  "radial-gradient(circle at top, var(--color-multipartkit) 30%, #000 100%)",
+      "documentation-intro-accent": "var(--color-multipartkit)",
+      "logo-base":  { "dark": "#fff", "light": "#000" },
+      "logo-shape": { "dark": "#000", "light": "#fff" },
+      "fill":       { "dark": "#000", "light": "#fff" }
+    },
+    "icons": { "technology": "/multipartkit/images/vapor-multipartkit-logo.svg" }
+  },
+  "features": {
+    "quickNavigation": { "enable": true },
+    "i18n": { "enable": true }
+  }
+}