Skip to content

Commit

Permalink
Revert "Update README with install instructions and updated links"
Browse files Browse the repository at this point in the history
This reverts commit cb522a1.
  • Loading branch information
mattyg committed Sep 24, 2024
1 parent 30637bf commit c9dde48
Show file tree
Hide file tree
Showing 7 changed files with 3 additions and 95 deletions.
98 changes: 3 additions & 95 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,100 +1,8 @@
# MewsFeed – for the calm cats
# mewsfeed

MewsFeed is a micro-blogging platform built with [Holochain](https://holochain.org).
We are currently working towards the first major release of MewsFeed.

Visit [mewsfeed.social](https://mewsfeed.social) to be notified of our release!

[Collaborate on GitHub](https://github.com/orgs/GeekGene/projects/1), [join our Discord](https://discord.gg/D3BykUZumM), and donate on [OpenCollective](https://opencollective.com/mewsfeed)!

## How to use MewsFeed

MewsFeed is built with the distributed app development framework Holochain. Practically, this means that users either host themselves on their own devices or access a web version through [the Holo hosting infrastructure](https://holo.host).

Here is how to decide which version to use:

**1. You are a Tinkerer 🛠️**
You like to experiment with the tools you use and enjoy having access to the data you use.

💻 Install MewsFeed locally, either as a Desktop App with Kangaroo or in the Holochain Launcher.

This way you can analyze your data, connect it to other tools, and tinker around.

**2. You are a Creator 🧑‍💻**
You like to publish good posts and interact with your audience wherever you are.

📲 Sign up for an account on [app.mewsfeed.social](https://app.mewsfeed.social).

This way you can use it from any device through the browser.

Alternatively, install MewsFeed locally and you'll be able to create content even when you're offline.

**3. You are an Anon 👤**
You want to stay anonymous, shitpost, and interact with interesting accounts.

💻 Install MewsFeed locally, either as a Desktop App with Kangaroo or in the Holochain Launcher.

This way you have access to your posts even when you don't have internet.

**4. You are a Lurker 👀**
You mostly just want to follow others for their content and stay informed of what's happening.

📲 Sign up for an account on [app.mewsfeed.social](https://app.mewsfeed.social) and use it from any device through the browser.

Alternatively, if you only browse content from your laptop or desktop, install it locally.

Either way, you'll be able to follow people and read their stuff.

**5. You are a casual User 😎**
You like following cool accounts, interacting with your friends, and having interesting conversations.

💻 Install MewsFeed locally, either as a Desktop App with Kangaroo or in the Holochain Launcher.

This way you can access your favorite content and send replies to your friends even when you're offline.

Alternatively, sign up on [app.mewsfeed.social](https://app.mewsfeed.social) and use it from any device through the browser.

### Install as Desktop App
Download the latest release of the Desktop App here: [MewsFeed Kangaroo](https://github.com/GeekGene/mewsfeed-kangaroo/releases/tag/v0.10.1).

Once installed, you'll be greeted by the Explore page.

![](img/Holochain_Launcher_Beta_2_Explore.png)

You have the ability to navigate around immediately (e.g. your feed).

![](img/Holochain_Launcher_Beta_2_Feed.png)

When you try to post your first Mew (i.e. Post), you'll be prompted with the profile setup modal.

![](img/Holochain_Launcher_Beta_2_Profile_Modal.png)

Set up your profile and start using the app!

### Install as hApp in the Holochain Launcher
Download the latest release of Holochain Launcher here: [Holochain Launcher](img/https://github.com/holochain/launcher/releases).

Install the Launcher, run it, and create a password (save it somewhere safe!). Then navigate to the hApp Store.

![](img/Holochain_Launcher_Beta_2_App_Store.png)

Install MewsFeed by clicking on it and hitting install.

![](img/Holochain_Launcher_Beta_2_MewsFeed_Peers_unavailable.png)

If no peers are online to download it from, head to the GitHub Releases page and download [the latest .webhapp file](https://github.com/GeekGene/mewsfeed/releases)

Then click "Select from filesystem" in the Launcher and select the file from your Downloads folder.

![](img/Holochain_Launcher_Beta_2_Appstore_MewsFeed_Install.png)

Leave the network seed blank if you want to join the regular MewsFeed network.

(Sidenote: if you want to set up a private version of MewsFeed for your community, just add a network seed and instruct your community members to also put that same seed into the box at install time to join your network)

You'll have to go through the same profile setup steps as described in the section on installing as desktop app.

### Use the Holo-hosted Web Version
This one is the easiest option. Just head on over to [app.mewsfeed.social](https://app.mewsfeed.social), sign up for an account, fill out your profile, and start using the platform!
[Collaborate on GitHub](https://github.com/orgs/GeekGene/projects/1) and [join our Discord](https://discord.gg/D3BykUZumM)!

## Chat With Us

Expand Down
Binary file removed img/Holochain_Launcher_Beta_2_App_Store.png
Binary file not shown.
Binary file not shown.
Binary file removed img/Holochain_Launcher_Beta_2_Explore.png
Binary file not shown.
Binary file removed img/Holochain_Launcher_Beta_2_Feed.png
Binary file not shown.
Binary file not shown.
Binary file removed img/Holochain_Launcher_Beta_2_Profile_Modal.png
Binary file not shown.

0 comments on commit c9dde48

Please sign in to comment.