mirror of
https://github.com/writefreely/writefreely
synced 2024-11-28 03:20:17 +00:00
89 lines
5 KiB
Markdown
89 lines
5 KiB
Markdown
|
||
<p align="center">
|
||
<a href="https://writefreely.org"><img src="https://writefreely.org/img/writefreely.svg" width="350px" alt="WriteFreely" /></a>
|
||
</p>
|
||
<hr />
|
||
<p align="center">
|
||
<a href="https://github.com/writefreely/writefreely/releases/">
|
||
<img src="https://img.shields.io/github/release/writefreely/writefreely.svg" alt="Latest release" />
|
||
</a>
|
||
<a href="https://travis-ci.org/writeas/writefreely">
|
||
<img src="https://travis-ci.org/writefreely/writefreely.svg" alt="Build status" />
|
||
</a>
|
||
<a href="https://github.com/writefreely/writefreely/releases/latest">
|
||
<img src="https://img.shields.io/github/downloads/writefreely/writefreely/total.svg" />
|
||
</a>
|
||
<a href="https://goreportcard.com/report/github.com/writefreely/writefreely">
|
||
<img src="https://goreportcard.com/badge/github.com/writefreely/writefreely" alt="Go Report Card" />
|
||
</a>
|
||
<a href="https://hub.docker.com/r/writeas/writefreely/">
|
||
<img src="https://img.shields.io/docker/pulls/writeas/writefreely.svg" />
|
||
</a>
|
||
</p>
|
||
|
||
|
||
WriteFreely is a clean, minimalist publishing platform made for writers. Start a blog, share knowledge within your organization, or build a community around the shared act of writing.
|
||
|
||
|
||
|
||
[Try the writing experience](https://write.as/new)
|
||
|
||
[Find an instance](https://writefreely.org/instances)
|
||
|
||
## Features
|
||
|
||
### Made for writing
|
||
|
||
Built on a plain, auto-saving editor, WriteFreely gives you a distraction-free writing environment. Once published, your words are front and center, and easy to read.
|
||
|
||
### A connected community
|
||
|
||
Start writing together, publicly or privately. Connect with other communities, whether running WriteFreely, [Plume](https://joinplu.me/), or other ActivityPub-powered software. And bring members on board from your existing platforms, thanks to our OAuth 2.0 support.
|
||
|
||
### Intuitive organization
|
||
|
||
Categorize articles [with hashtags](https://writefreely.org/docs/latest/writer/hashtags), and create static pages from normal posts by [_pinning_ them](https://writefreely.org/docs/latest/writer/static) to your blog. Create draft posts and publish to multiple blogs from one account.
|
||
|
||
### International
|
||
|
||
Blog elements are localized in 20+ languages, and WriteFreely includes first-class support for non-Latin and right-to-left (RTL) script languages.
|
||
|
||
### Private by default
|
||
|
||
WriteFreely collects minimal data, and never publicizes more than a writer consents to. Writers can seamlessly create multiple blogs from a single account for different pen names or purposes without publicly revealing their association.
|
||
|
||
<h2><a href="https://write.as/writefreely"><img src="https://writefreely.org/img/writeas-readme.png" height="32px" alt="Write.as" /></a></h2>
|
||
|
||
The quickest way to deploy WriteFreely is with [Write.as](https://write.as/writefreely), a hosted service from the team behind WriteFreely. You'll get fully-managed installation, backup, upgrades, and maintenance — and directly fund our free software work ❤️
|
||
|
||
[**Learn more on Write.as**](https://write.as/writefreely).
|
||
|
||
## Quick start
|
||
|
||
WriteFreely deploys as a static binary on any platform and architecture that Go supports. Just use our built-in SQLite support, or add a MySQL database, and you'll be up and running!
|
||
|
||
For common platforms, start with our [pre-built binaries](https://github.com/writefreely/writefreely/releases/) and head over to our [installation guide](https://writefreely.org/start) to get started.
|
||
|
||
### Packages
|
||
|
||
You can also find WriteFreely in these package repositories, thanks to our wonderful community!
|
||
|
||
* [Arch User Repository](https://aur.archlinux.org/packages/writefreely/)
|
||
|
||
## Documentation
|
||
|
||
Read our full [documentation on WriteFreely.org](https://writefreely.org/docs) —️ and help us improve by contributing to the [writefreely/documentation](https://github.com/writefreely/documentation) repo.
|
||
|
||
## Development
|
||
|
||
Start hacking on WriteFreely with our [developer setup guide](https://writefreely.org/docs/latest/developer/setup). For Docker support, see our [Docker guide](https://writefreely.org/docs/latest/admin/docker).
|
||
|
||
## Contributing
|
||
|
||
We gladly welcome contributions to WriteFreely, whether in the form of [code](https://github.com/writefreely/writefreely/blob/master/CONTRIBUTING.md#contributing-to-writefreely), [bug reports](https://github.com/writefreely/writefreely/issues/new?template=bug_report.md), [feature requests](https://discuss.write.as/c/feedback/feature-requests), [translations](https://poeditor.com/join/project/TIZ6HFRFdE), or [documentation](https://github.com/writefreely/documentation) improvements.
|
||
|
||
Before contributing anything, please read our [Contributing Guide](https://github.com/writefreely/writefreely/blob/master/CONTRIBUTING.md#contributing-to-writefreely). It describes the correct channels for submitting contributions and any potential requirements.
|
||
|
||
## License
|
||
|
||
Copyright © 2018-2022 [Musing Studio LLC](https://musing.studio) and contributing authors. Licensed under the [AGPL](https://github.com/writefreely/writefreely/blob/develop/LICENSE).
|