|
| 1 | +<div align="center"> |
| 2 | + |
1 | 3 | [![Build Status][build status badge]][build status] |
2 | 4 | [![License][license badge]][license] |
3 | 5 | [![Platforms][platforms badge]][platforms] |
4 | 6 | [![Documentation][documentation badge]][documentation] |
5 | 7 |
|
| 8 | +</div> |
| 9 | + |
6 | 10 | # TextFormation |
7 | 11 |
|
8 | 12 | TextFormation is simple rule system that can be used to implement typing completions and whitespace control. Think matching "}" with "{" and indenting. |
9 | 13 |
|
10 | 14 | > [!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. |
12 | 16 |
|
13 | 17 | ## Integration |
14 | 18 |
|
15 | 19 | ```swift |
16 | 20 | dependencies: [ |
17 | | - .package(url: "https://github.com/ChimeHQ/TextFormation", from: "0.8.0") |
| 21 | + .package(url: "https://github.com/ChimeHQ/TextFormation", branch: "main") |
18 | 22 | ] |
19 | 23 | ``` |
20 | 24 |
|
@@ -104,11 +108,15 @@ TextualIndenter.rubyPatterns |
104 | 108 | TextualIndenter.pythonPatterns |
105 | 109 | ``` |
106 | 110 |
|
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. |
108 | 116 |
|
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. |
110 | 118 |
|
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). |
112 | 120 |
|
113 | 121 | [build status]: https://github.com/ChimeHQ/TextFormation/actions |
114 | 122 | [build status badge]: https://github.com/ChimeHQ/TextFormation/workflows/CI/badge.svg |
|
0 commit comments