Skip to content

Commit 9375607

Browse files
committed
Added readme
1 parent 06eead1 commit 9375607

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# **Frost**
2+
3+
Frost is an app for [Cozy Cloud](http://cozy.io) that lets you take snapshots of webpages so you can keep them around forever.
4+
5+
*Introduction en français [ici](https://forum.cozy.io/t/frost-application/2123)*
6+
7+
![Frost screenshot](https://forum.cozy.io/uploads/default/original/1X/94599e30da39e09b29456ae3ca8527de90ee0a83.png)
8+
9+
Link rot is a huge problem on the web, and it's especially painful when one of your favorite pages just vanishes. Services like the [Wayback Machine](https://archive.org/web/) or [Pinboard](https://pinboard.in/) are great, but they rely on someone having money to maintain the service and in the end, you still don't own your data. A personnal cloud is therefor the ideal place to store snapshots of sites you care about, and this is what Frost does.
10+
11+
**Frost is currently in alpha. Things work mostly fine and you're welcome to try it, but please hold on a bit more before starting serious usage.**
12+
13+
## What is Cozy?
14+
15+
![Cozy Logo](https://raw.github.com/mycozycloud/cozy-setup/gh-pages/assets/images/happycloud.png)
16+
17+
[Cozy](http://cozy.io) is a platform that brings all your web services in the
18+
same private space. With it, your web apps and your devices can share data
19+
easily, providing you
20+
with a new experience. You can install Cozy on your own hardware where no one
21+
profiles you.
22+
23+
## Community
24+
25+
You can reach the Cozy Community by:
26+
27+
* Chatting with us on IRC #cozycloud on irc.freenode.net
28+
* Posting on our [Forum](https://forum.cozy.io/)
29+
* Posting issues on the [Github repos](https://github.com/cozy/)
30+
* Mentioning us on [Twitter](http://twitter.com/mycozycloud)
31+
32+
# Contributing
33+
34+
This is a side project and while there are ton of possible features, I'm not sure I'll ever get around creating them all. But outside contributions are very welcome.
35+
36+
I'll update this guide later, but basically:
37+
38+
- The server is a node app. Run `node server` to start it. You need the cozy dev stack installed on your machine.
39+
- The client part is written wth [Aurelia](http://aurelia.io/), because I wanted to try it. The sources are for the js are in the `src` folder. You'll need to run `gulp watch` or `gulp bundle` in the root folder to run the file processing. The main html and css files are in the `client` dir. You also need jspm installed. Like I said, I'll write a proper guide at some point.

0 commit comments

Comments
 (0)