You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-27Lines changed: 27 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,21 @@
1
1
# swift-html-css-pointfree
2
2
3
-
A Swift package that provides a type-safe DSL for HTML and CSS.
3
+
⚠️ **This is an integration package. For end-user development, please use [coenttb/swift-html](https://github.com/coenttb/swift-html) instead.**
4
4
5
-
Built upon [coenttb/swift-html-types](https://www.github.com/coenttb/swift-html-types), [coenttb/swift-css-types](https://www.github.com/coenttb/swift-css-types), and rendered by [coenttb/pointfree-html](https://www.github.com/coenttb/pointfree-html).
This package serves as an integration layer that combines:
8
+
-[swift-html-types](https://github.com/coenttb/swift-html-types) - Type definitions for HTML elements and attributes
9
+
-[swift-css-types](https://github.com/coenttb/swift-css-types) - Type definitions for CSS properties and values
10
+
-[pointfree-html](https://github.com/coenttb/pointfree-html) - HTML rendering engine
8
11
9
-
This package is currently in active development and is subject to changes. Features and APIs may change without prior notice until a stable release is available.
12
+
It provides the foundational PointFree HTML integration that powers the higher-level [swift-html](https://github.com/coenttb/swift-html) package.
10
13
11
-
## Features
14
+
## For Developers
12
15
13
-
-**Type-safe HTML and DSL**: Write HTML Elements and HTML Attributes with a SwiftUI-like syntax
14
-
-**Integrated CSS styling**: Apply CSS styles directly to HTML elements with a SwiftUI-like syntax
15
-
-**Comprehensive coverage**: Support for all standard HTML5 Elements and Attributes, and all CSS Properties and Types
16
-
-**Concurrency Safe**: Full Swift 6 support
16
+
**👉 Use [coenttb/swift-html](https://github.com/coenttb/swift-html) for your projects.**
17
17
18
-
## Examples
18
+
The `swift-html` package provides a complete, developer-friendly API for building type-safe HTML and CSS in Swift with a SwiftUI-like syntax:
19
19
20
20
```swift
21
21
importHTML
@@ -31,34 +31,34 @@ let document = HTMLDocument {
31
31
}
32
32
```
33
33
34
-
## Installation
34
+
## Package Architecture
35
35
36
-
### Swift Package Manager
36
+
This integration package consists of several modules:
37
37
38
-
Add the dependency in your `Package.swift` file:
38
+
-**HTMLElements+PointFreeHTML** - PointFree HTML extensions for HTML elements
39
+
-**HTMLAttributes+PointFreeHTML** - PointFree HTML extensions for HTML attributes
40
+
-**CSS+PointFreeHTML** - PointFree HTML extensions for CSS properties
41
+
-**HTML+CSS+PointFreeHTML** - Combined HTML and CSS functionality
42
+
43
+
## Installation (Internal Use Only)
44
+
45
+
This package is typically used as a dependency by other packages in the ecosystem. If you need to use it directly:
2. Enter package URL: `https://github.com/coenttb/swift-html-css-pointfree`
50
-
3. Choose the main branch or a specific version
51
-
52
-
## Integration with Web Frameworks
53
-
54
-
This package is designed to work seamlessly with Swift web frameworks like Vapor. See [coenttb-com-server](https://www.github.com/coenttb/coenttb-com-server) for an example implementation.
53
+
## Related Packages
55
54
56
-
## Related Projects
55
+
### For End Users
56
+
***[swift-html](https://www.github.com/coenttb/swift-html)** - **👈 Start here!** Complete Swift DSL for HTML and CSS
57
57
58
-
*[swift-html-types](https://www.github.com/coenttb/swift-html-types): A complete Swift domain model of HTML elements and attributes.
59
-
*[swift-css-types](https://www.github.com/coenttb/swift-css-types): A complete Swift domain model of CSS properties and types.
60
-
*[pointfree-html](https://www.github.com/coenttb/pointfree-html): Swift DSL for rendering type-safe HTML.
61
-
*[swift-html](https://www.github.com/coenttb/swift-html): Swift DSL for rendering type-safe HTML and CSS.
58
+
### Foundation Packages
59
+
*[swift-html-types](https://www.github.com/coenttb/swift-html-types) - HTML type definitions
60
+
*[swift-css-types](https://www.github.com/coenttb/swift-css-types) - CSS type definitions
61
+
*[pointfree-html](https://www.github.com/coenttb/pointfree-html) - HTML rendering engine
0 commit comments