Skip to content

Commit fb32614

Browse files
Update readme
1 parent 44c3545 commit fb32614

1 file changed

Lines changed: 13 additions & 5 deletions

File tree

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
1+
<div align="center">
2+
13
[![Build Status][build status badge]][build status]
24
[![License][license badge]][license]
35
[![Platforms][platforms badge]][platforms]
46
[![Documentation][documentation badge]][documentation]
57

8+
</div>
9+
610
# TextFormation
711

812
TextFormation is simple rule system that can be used to implement typing completions and whitespace control. Think matching "}" with "{" and indenting.
913

1014
> [!WARNING]
11-
> There's some major work happening on the `feature/process-mutation` branch to support much more sophisticated text mutation patterns
15+
> This library is undergoing some major changes. Not all functionality is currently implemented in the main branch yet.
1216
1317
## Integration
1418

1519
```swift
1620
dependencies: [
17-
.package(url: "https://github.com/ChimeHQ/TextFormation", from: "0.8.0")
21+
.package(url: "https://github.com/ChimeHQ/TextFormation", branch: "main")
1822
]
1923
```
2024

@@ -104,11 +108,15 @@ TextualIndenter.rubyPatterns
104108
TextualIndenter.pythonPatterns
105109
```
106110

107-
### Suggestions or Feedback
111+
## Contributing and Collaboration
112+
113+
I would love to hear from you! Issues or pull requests work great. Both a [Matrix space][matrix] and [Discord][discord] are available for live help, but I have a strong bias towards answering in the form of documentation. You can also find me on [the web](https://www.massicotte.org).
114+
115+
I prefer collaboration, and would love to find ways to work together if you have a similar project.
108116

109-
We'd love to hear from you! Get in touch via an issue or pull request.
117+
I prefer indentation with tabs for improved accessibility. But, I'd rather you use the system you want and make a PR than hesitate because of whitespace.
110118

111-
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
119+
By participating in this project you agree to abide by the [Contributor Code of Conduct](CODE_OF_CONDUCT.md).
112120

113121
[build status]: https://github.com/ChimeHQ/TextFormation/actions
114122
[build status badge]: https://github.com/ChimeHQ/TextFormation/workflows/CI/badge.svg

0 commit comments

Comments
 (0)