Commit 3e2ff5f3 authored by Luc Didry's avatar Luc Didry

Add README, LICENSE and AUTHORS files

parent 91e07880
# Lufi's authors
## Main developers
* Luc Didry, aka Sky (<http://www.fiat-tux.fr>), core developer, @framasky on [Twitter](https://twitter.com/framasky) and on [Diaspora*](https://framasphere.org/public/framasky)
* No one else right now
This diff is collapsed.
# Lufi
## What does Lufi mean?
Lufi means Let's Upload that FIle.
## What does it do?
It stores files and allows you to download them.
Is that all? No. All the files are encrypted **by the browser**! It means that your files **never** leave your computer unencrypted.
The administrator of the Lufi instance you use will not be able to see what is in your file, and your network administrator neither. Neither can do your ISP.
## License
Lufi is licensed under the terms of the AGPL. See the LICENSE file.
## Official instance
Not for now. Lufi is still in development.
## Logo
Because Lufi is quite similar to Luffy, like in "[Monkey D. Luffy](https://en.wikipedia.org/wiki/Monkey_D._Luffy)" from [One Piece](https://en.wikipedia.org/wiki/One_Piece) manga, the logo is a straw hat, made with pain, love and [Inkscape](https://inkscape.org/).
## Wiki (work in progress)
The official wiki will contain all what you need to know about Lufi (installation, configuration, etc). Go to <https://git.framasoft.org/luc/lufi/wikis/home> or clone it:
```
git clone https://git.framasoft.org/luc/lufi.wiki.git
```
## Encryption
All the encryption/decryption process takes place on your browser. The encryption key never go on the network.
But please, notice that some meta-datas are send unencrypted:
* the file name
* its size
* its mimetype
## Internationalization
Lufi comes with English and French languages. It will choose the language to display from the browser's settings.
## Authors
See [AUTHORS.md](AUTHORS.md) file.
## Contribute!
Please consider contributing, either by [reporting issues](https://git.framasoft.org/luc/lufi/issues) or by helping the [internationalization](https://pootle.framasoft.org/projects/lufi/). And of course, code contribution are welcome!
The details on how to contribute are on the [wiki](https://git.framasoft.org/luc/lufi/wikis/contribute).
## Others projects dependancies
Lufi is written in Perl with the [Mojolicious](http://mojolicio.us) framework.
It uses:
* [Twitter bootstrap](http://getbootstrap.com) framework to look not too ugly
* [Stanford Javascript Crypto Library](http://bitwiseshiftleft.github.com/sjcl/)
* [Moment.js](http://momentjs.com/) for displaying real dates instead of unix timestamps.
* [Fontello](http://fontello.com/) for the icons, licenses for the fontello icons fonts are in `public/font/LICENSE.txt`
Yup, no jQuery here, just old good vanilla javascript.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment