Skip to content

Commit 6b5f943

Browse files
authored
Update README with new version and lead-in chamfers
Updated version number in installation instructions and added lead-in chamfers section.
1 parent fc0d5eb commit 6b5f943

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ Helical is a library for [Cadova](https://github.com/tomasf/Cadova) that simplif
44

55
<img src="https://github.com/user-attachments/assets/f4fef516-f493-4034-baa2-bf6026ed4f68" />
66

7-
87
[Bolts demo](Sources/Demo/bolts.stl) · [Nuts and washers demo](Sources/Demo/nutsAndWashers.stl)
8+
99
## Installation
1010

1111
Integrate Helical into your project with the Swift Package Manager by adding it as a dependency in your `Package.swift` file:
1212

1313
```swift
14-
.package(url: "https://github.com/tomasf/Helical.git", from: "0.4.1")
14+
.package(url: "https://github.com/tomasf/Helical.git", from: "1.0.0")
1515
```
1616

1717
Then, import Helical where it's needed:
@@ -24,7 +24,7 @@ import Helical
2424

2525
### Standard Components
2626

27-
Helical simplifies the process of creating threaded shapes, making it easier to incorporate threaded holes into your models. It also provides a selection of standard bolts, nuts, and corresponding holes. Creating a typical M8x30 hex head bolt is simple:
27+
Helical simplifies the process of creating threaded shapes, making it easier to incorporate threaded holes into your models. It also provides a selection of standard bolts, nuts, and corresponding holes. Creating a typical M8x20 hex head bolt is simple:
2828

2929
```swift
3030
Bolt.hexHead(.m8, length: 20, unthreadedLength: 5)
@@ -92,10 +92,20 @@ As is making a threaded hole for a particular thread:
9292
Box(13)
9393
.aligned(at: .centerXY)
9494
.subtracting {
95-
ThreadedHole(thread: thread, depth: 13)
95+
ThreadedHole(thread: thread, depth: 13, leadIns: .both)
9696
}
9797
```
9898

99+
### Lead-In Chamfers
100+
101+
`LeadIn` and `LeadInEnds` provide a unified way to add thread-entry chamfers to screws, threaded holes, and nuts. Size can be specified relative to thread depth, pitch, or cone angle, or as explicit dimensions:
102+
103+
```swift
104+
Screw(thread: .isoMetric(.m6), length: 20, leadIns: .both(.standard))
105+
106+
Nut(thread: .isoMetric(.m6), shape: body, leadIns: .both(.angle(120°)))
107+
```
108+
99109
## Behavior
100110

101111
<img align="right" width="200" src="https://github.com/user-attachments/assets/8b56d947-e295-439e-96c7-04b7bec1b7fe" />
@@ -111,4 +121,3 @@ Helical uses Cadova's `tolerance` environment setting to increase the diameter o
111121
## Contributing
112122

113123
We welcome contributions. Feel free to open issues for feedback or suggestions and submit pull requests for improvements to the codebase.
114-

0 commit comments

Comments
 (0)