TudbuT/conduit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update README.md

Browse source 
Signed-off-by: strawberry <strawberry@puppygock.gay>
This commit is contained in:
strawberry 2024-04-25 23:53:00 -04:00 • committed by June
parent 8574d0758e
commit e8508d16e1
2 changed files with 6 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -1,13 +1,14 @@
# conduwuit # conduwuit
[![CI and Artifacts](https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml) `main` / stable: [![CI and Artifacts](https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml)
`dev`: [![CI and Artifacts](https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml/badge.svg?branch=dev)](https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml)
<!-- ANCHOR: catchphrase --> <!-- ANCHOR: catchphrase -->
### a well maintained hard fork of [Conduit](https://conduit.rs/) ### a very cool, featureful fork of [Conduit](https://conduit.rs/)
<!-- ANCHOR_END: catchphrase --> <!-- ANCHOR_END: catchphrase -->
Visit the [Conduwuit documentation](https://conduwuit.puppyirl.gay/) for more information. Visit the [Conduwuit documentation](https://conduwuit.puppyirl.gay/) for more information.
Alternatively you can open [docs/introduction.md](docs/introduction.md) in this repository.
<!-- ANCHOR: body --> <!-- ANCHOR: body -->
#### What is Matrix? #### What is Matrix?
@ -33,18 +34,6 @@ conduwuit is a hard fork of Conduit which is in beta, meaning you can join and p
Matrix rooms, but not all features are supported and you might run into bugs Matrix rooms, but not all features are supported and you might run into bugs
from time to time. from time to time.
#### Why does this hard fork exist? Why don't you contribute back upstream?
I now intend on contributing back as time and mental energy sees fit, but my fork still exists as a way to:
- avoid unnecessary Matrix and general developer politics
- avoid bikeshedding unnecessary or irrelevant things in upstream MRs
- Fast tracked bug fixes, performance improvements, security improvements, and new features
- Have early access to MRs that may not be suitable/acceptable for Conduit (e.g. too niche, too advanced for general users, only being blocked due to pending on contributor actions that we can fix ourselves downstream, pending Matrix spec stuff, etc)
- Support unspecced or WIP features
- Have official support for other OS's like Windows, macOS, and BSD.
- Have a **stable** testing ground for some MRs or new features and bug fixes
And various other reasons that may not be listed here.
<!-- ANCHOR_END: body --> <!-- ANCHOR_END: body -->
<!-- ANCHOR: footer --> <!-- ANCHOR: footer -->
@ -75,7 +64,7 @@ No official conduwuit logo exists. Original repo and Matrix room picture was fro
#### Is it conduwuit or Conduwuit? #### Is it conduwuit or Conduwuit?
Both. Both, but I prefer conduwuit.
#### Mirrors of conduwuit #### Mirrors of conduwuit

2
docs/differences.md
View file

@ -87,7 +87,7 @@ Outgoing typing indicators, outgoing read receipts, **and** outgoing presence!
## Maintenance/Stability: ## Maintenance/Stability:
- GitLab CI ported to GitHub Actions - GitLab CI ported to GitHub Actions
- Repo is mirrored to GitHub, GitLab, git.gay, and Codeberg - Repo is mirrored to GitHub, GitLab, git.gay, sourcehut, and Codeberg (see README.md for their links)
- Extensively revamp the example config to be extremely helpful and useful to both new users and power users - Extensively revamp the example config to be extremely helpful and useful to both new users and power users
- Fixed every single clippy (default lints) and rustc warnings, including some that were performance related or potential safety issues / unsoundness - Fixed every single clippy (default lints) and rustc warnings, including some that were performance related or potential safety issues / unsoundness
- Add a **lot** of other clippy and rustc lints and a rustfmt.toml file - Add a **lot** of other clippy and rustc lints and a rustfmt.toml file