Skip to content

Commit 4855048

Browse files
committedSep 29, 2017
Revert "[docs] Updated ReadMe, added new logos"
This reverts commit 94b6c25.
1 parent c467167 commit 4855048

File tree

9 files changed

+20
-50
lines changed

9 files changed

+20
-50
lines changed
 

‎README.md

+20-50
Original file line numberDiff line numberDiff line change
@@ -1,86 +1,56 @@
11
<h1 align="center">
22
<br>
3-
<img src="/assets/logo/64.png" alt="LolaShare" width="200">
3+
<a href="http://ferment.audio"><img src="/ferment-logo.png" alt="Ferment" width="200"></a>
44
<br>
5-
LolaShare
5+
Ferment
66
<br>
77
<br>
88
</h1>
99

1010

11-
LolaShare is a peer-to-peer audio publishing and streaming application. Think SoundCloud or Spotify, but entirely decentralized and free.
11+
[Ferment](http://ferment.audio) is a peer-to-peer audio publishing and streaming application. Think SoundCloud or Spotify, but entirely decentralized and free.
1212

1313
---
1414

1515
**Current Status**
1616

17-
Since our initial Alpha release last year, we have made vast improvements to our underlying [peer to peer communication network](https://github.com/ssbc). Armed with the knowledge we have learned in the past year and our improved network software, we are working on taking LolaShare to the next level with our Beta release.
17+
Since our initial Alpha release last year, we have made vast improvements to our underlying [peer to peer communication network](https://github.com/ssbc). Armed with the knowledge we have learned from our Alpha release and our more robust peer to peer network, we are working on taking Ferment to the next level with a Beta release.
1818

19-
**LolaShare Network is offline**
19+
**Ferment Network is offline**
2020

21-
Don't be worried! We'll be back online very soon.
22-
23-
As we prepare our new Beta version we have taken the main LolaShare "pub" offline. This means that until our next release, you will not be able to join the p2p network.
24-
25-
If you'd like to help please see our [Contributing](#contributing) section.
21+
As we prepare our new Beta version, we have taken the main Ferment "pub" offline for updates. This means that until our next release, you will not be able to join the p2p network.
2622

2723
---
2824

29-
*a screenshot from our alpha release, codename: Ferment*
30-
<img src="/assets/ferment-screenshot-0.0.0.jpg" alt="Alpha Screenshot" width="888" height="688" />
31-
32-
## Inspiration
33-
34-
The costs associated with running a traditional streaming music site far outweigh the amount of revenue any traditional business model can support (without severely affecting user experience). We can see this now with SoundCloud's high prices and constant advertisements. Other streaming services are losing money every year and are not sustainable.
25+
[ Watch a quick video demo](https://www.youtube.com/watch?v=xgvxXbWYmrI)
3526

36-
There is no money in hosting other people's content for free, and these existing music sharing companies need to maintain high revenues to stay in business keep their investors happy.
27+
[ Download for macOS](https://github.com/mmckegg/ferment/releases)
3728

38-
Ultimately, this is bad for the users and content creators. There is an implicit tie-in to these services. APIs disappear one-by-one, data formats close up, previous free features are put behind paywalls. You become dependent on them, and then they change all your favourite features or simply just shut down.
29+
[ Build from source](#install)
3930

40-
Our vision is a future where users truely control their own content through socially connected systems which interact on a personal level.
31+
<img src="/assets/ferment-screenshot-0.0.0.jpg" alt="WebTorrent" width="888" height="688" />
4132

42-
## Who we are
33+
## Requirements
4334

44-
LolaShare is made by a group of like-minded open-source software developers with a common love for making music.
35+
**TODO**
4536

46-
We wanted to create a free and open solution for original music creators to share and discover new works of music.
37+
## Inspiration
4738

48-
Some of us have been working together on open-source software projects for almost a decade, while others have just recently joined the cause.
39+
**TODO**
4940

5041
## How it works
5142

52-
LolaShare uses a peer-to-peer gossip protocol called [SSB](https://github.com/ssbc). **There is no central server and no single point of failure.** Everyone on the network acts a server, maintaing a copy of all of their friends and their friend's friends data.
53-
54-
LolaShare will gossip ( securely communicate ) with other peers ( your friends) to find out if any of your shared contacts have posted new materials. All posts are cryptographically proven with an append-only log, ensuring no posts are skipped or lost.
55-
56-
Traditionally, finding peers across a complex network topography ( the internet ) has been a difficult problem. This is why LolaShare uses "pub" servers. A "pub" acts as gossip broker where information can be shared across networks. A "pub" is just an ordinary LolaShare peer which has a publicly accessible IP address and may be remotely connected to on demand. LolaShare will maintain several "main" pubs, ensuring there is always an easy way to connect and begin discoverying new music and content creators.
57-
58-
The actual audio files are Torrents powered by [webtorrent](webtorrent.io) over the WebRTC protocol. [SSB](github.com/ssbc) is used to propigate messages between peers which contains a link to a magnet url. It sounds complex, but LolaShare is able to present this seamlessly to users through a simple upload form, much like other music sharing sites.
59-
60-
Whenever you listen to audio in LolaShare, you will begin to seed that file with other peers. The audio will be cached on your machine until you remove it, or decide to stop sharing it.
61-
62-
## LolaShare and Copyright
63-
64-
LolaShare is an audio publishing platform for **copyright-owning creators**, **creative commons licensed material**, **remix artists** and **DJs**.
65-
66-
Since LolaShare is a decentralized, peer-to-peer community, what you culture in your network is up to you. We stongly recommend users abide by the applicable copyright laws of their country.
67-
68-
For example, if someone in your network ( your friends ) added copyrighted material, and you listen to it, your LolaShare will start sharing the file. If you don't want to share the legal responsibility for this, right-click and select 'Stop Sharing Post.' You should also consider unfollowing them and reporting the infringement to the owner of the pub to prevent the spread of the material.
69-
70-
LolaShare itself will **never** host any non-creative commons materials or maintain a directory of links to copy-righted materials. We own no servers and maintain no music database.
71-
72-
## Installation
43+
**TODO**
7344

74-
Since we are in the process of making a major network update, we've currently removed installation and build instructions.
45+
## Ferment and Copyright
7546

76-
We'll be adding cross-platform installation and build instructions back as soon as our Beta version is able to connect to the updated SSB network.
47+
Ferment is an audio publishing platform for **copyright-owning creators**, **creative commons licensed material**, **remix artists** and **DJs**. As this is a decentralized, peer-to-peer community, what you culture in your network is up to you. **You get to choose what level of sharing legality you are comfortable with.**
7748

78-
If you are curious, you can view our previous Alpha releases (codename: "Ferment") for MacOS [here](https://github.com/fermentation/ferment/releases), but it won't be able to connect anywhere since our main pub is currently being updated.
49+
For example, if someone in your network adds copyrighted material, and you listen to it, your Ferment will start sharing the file. If you don't want to share the legal responsibility for this, right-click and select 'Stop Sharing Post.'
7950

80-
<a name="contributing"></a>
81-
## Contributing to the project
51+
You could also consider unfollowing them and reporting the infringement to the owner of the pub to prevent the spread of the material.
8252

83-
**TODO**
53+
**A pub owner should unfollow anyone who adds material which infringes copyright.**
8454

8555
## License
8656

‎assets/logo/128.png

-15.1 KB
Binary file not shown.

‎assets/logo/24.png

-2.08 KB
Binary file not shown.

‎assets/logo/256.png

-36 KB
Binary file not shown.

‎assets/logo/32.png

-2.91 KB
Binary file not shown.

‎assets/logo/40.png

-3.88 KB
Binary file not shown.

‎assets/logo/48.png

-4.77 KB
Binary file not shown.

‎assets/logo/64.png

-6.74 KB
Binary file not shown.

‎assets/logo/96.png

-10.6 KB
Binary file not shown.

0 commit comments

Comments
 (0)
Please sign in to comment.