<aclass="button"href="https://demo.yarn.social/">Try it **now**!</a>
@ -33,7 +33,7 @@ Yarn.social's multi-user decentralised and distributed software called `yarnd`,
or you can [Run-a-pod](#run-a-pod) yourself on your own server (or even on a
Raspberry Pi )! And finally you can [Manually](#manually) host your own feed and use any "compatible" client of your choosing, or write a new one that implements the [specifications](https://dev.twtxt.net). Enjoy! 🤗
### 🤗 Join an existing Pod
### 🤗 Join an existing Pod {#join}
{{ jointoday.sh }}
@ -44,13 +44,13 @@ You are welcome to join one of the existing pods listed here:
**Note:** Due to increased spam and link submission bots and/or marketing/seo
type folks that don't know any better, _some_ pods have disabled "Open Registration". If you'd like to join a pod that has registrations disabled, you'd best contact its operator. An [Invite System](https://git.mills.io/yarnsocial/yarn/issues/695) will be built soon.™
### 📱 Mobile App
### 📱 Mobile App {#app}
There is a native Mobile App for Yarn.social pods!
**NOTE:** The mobile app is being rebuilt and re-branded. [Test versions](https://twtxt.net/twt/uyrspdq) are available.
### 🧶 Run-a-Pod
### 🧶 Run-a-Pod {#run}
<aclass="button"href="https://my.vultr.com/deploy?marketplace_app=yarn&marketplace_vendor_username=prologic">Deploy to Vultr!</a>
@ -87,10 +87,10 @@ guide for a production pod setup.
For other setups and community documentation on setting up a Yarn.social pod, please see [Our Pod Owners' Wiki](https://git.mills.io/yarnsocial/yarn/wiki/); contributions are very welcome!
### 💪 Manually
### 💪 Self Host Manually {#self-host}
Joining the Yarn.social / Twtxt social ecosystem is as simple as writing a
RFC3339 timestamp, followed by a tab and your post to a text file, and then hosting that on a public webserver. For example:
RFC3339 timestamp, followed by a tab and your post to a text file, and then hosting that on a public webserver. For example:
```console
$ echo -e "$(date -Is)\tHello World" >> twtxt.txt
@ -118,7 +118,7 @@ development team and community. For example, being able to participate in
Metadata extensions to advertise information about your feed, such as a
description and avatar.
### 🕸 Clients
### 🕸 Clients {#clients}
The following clients are modern up-to-date and well maintained clients that
fully support the [Twtxt](https://twtxt.readthedocs.org)
@ -130,7 +130,7 @@ and [Twtxt Extensions](https://dev.twtxt.net):
- [jdtron/twet](https://github.com/jdtron/twet): A command-line client
- [twtr](https://git.envs.net/duriny/twtr): A twtxt client written in Go, for all your twting needs
### 📕 Example
### 📕 Example {#example}
A complete example of a feed would look like this:
@ -142,11 +142,11 @@ Which also happens to be the same feed at [twtxt.txt](/twtxt.txt); you can follo
Enjoy! 🤗
### 🌐 Hosting
### 🌐 Hosting {#hosting}
> Coming soon™
## 👨🔧 Services
## 👨🔧 Services {#services}
The following supporting services help to support the Yarn.social platform and
are provided for the benefit of all users:
@ -155,7 +155,7 @@ are provided for the benefit of all users:
- [feeds.twtxt.net](https://feeds.twtxt.net): This is an instance of [rss2twtxt](//git.mills.io/yarnsocial/rss2twtxt) and is used as the primary "feed source" for all Yarn.social pods (by default)
and supports RSS/Atom and Twitter™. This allows users to "subscribe" to and "follow" websites, blogs or Twitter™ accounts.
## 💾 Sources
## 💾 Sources {#source}
The project is managed by a self-hosted [Gitea](https://gitea.io) instance
🐦 A Flutter iOS and Android app for the Yarn.social `yarnd` API to provide a native mobile experience for users (*which is in the process of being rebuilt*).
## 👨💻👩💻 Contributing
## 👨💻👩💻 Contributing {#contributing}
Please contribute to our [collective](https://opencollective.com/yarnsocial/donate), every donation helps us continue to improve the software, ecosystem, mobile app(s) and supporting services that make up Yarn.social 🙏
@ -177,14 +177,14 @@ Otherwise you can help the project by contributing ideas, bug fixes, improvement
Please reach out to [@prologic](https://twtxt.net/user/prologic) or join our [Gitea](https://gitea.io) instance at https://git.mills.io/ and start filing issues and pull requests to the [main project](https://git.mills.io/yarnsocial/yarn).
## 💬 Collaboration
## 💬 Collaboration {#contact}
We have an IRC channel `#Yarn.social` on the [Libera.Chat](https://libera.chat/)
IRC network. You are welcome to come chat with us and hang out.
For your convenience, you _may_ wish to use the [Web Chat](https://web.libera.chat/#Yarn.social) client.
## 🕵️♂️ Privacy and Abuse Policy
## 🕵️♂️ Privacy and Abuse Policy {#policies}
Yarn.social is a decentralised social media platform that supports micro-blogging (Twts) and full blogging. Pods (or individual instances) are owned and operators by "Pod Owners" or "Pod Operators". Pods can either be configured as single-user or multi-user (the default).
@ -195,7 +195,7 @@ As such all Yarn.social pods share the following default Abuse and Privacy polic
__Note:__ The privacy policy applies to **ALL** Yarn.social pods as the software `yarnd`**DOES NOT** collect any personally identifiable information from users (i.e., **no PII**), or any metadata or analytics of any kind, nor does it send, sell or transfer any data from pods to any third parties.
## 🙋♀️ 🙋♂️ FAQ
## 🙋♀️ 🙋♂️ FAQ {#faq}
Q: Is Yarn.social a "social media" alternative?
@ -238,7 +238,7 @@ a lot of feeds settled on anyways, this might help you:
See [FAQ](/faq.html) for more frequently asked questions.
## 👨⚖️ Licenses
## 👨⚖️ Licenses {#license}
Most of the software components here are licensed under the terms of the
[AGPL-3.0 License](https://opensource.org/licenses/AGPL-3.0) with the exception of the hosting platform.
James Mills
6 days ago
