README.md

![Cesium logo](https://github.com/duniter/cesium/raw/master/www/img/logo_144px.png)

# Cesium

Cesium is wallet client software for [Duniter](https://duniter.org) crypto-currency, like Ğ1.
Cesium allow you to manage your wallet, certify your friends, and more!

Cesium is an [Unhosted](https://unhosted.org) Progressive Web Application (PWA), using AngularJS and Ionic.

Please visit th Cesium web site: [cesium.app](https://cesium.app)

## Install

### As a web extension (Firefox, Chrome)

 - Download the [latest extension release](https://github.com/duniter/cesium/releases/latest)
 
 - Drag/drop the file into your browser;
 
 - Confirm the installation.
 
 That's it! A new button is appeared, on the top right corner.
 
### On desktop computer

 - Download the [latest release](https://github.com/duniter/cesium/releases/latest)
 
 - Then install, depending on your operating system:  
    * Ubuntu: Double click the `.deb` file
    * Debian: Run the command `sudo dpkg -i *.deb`
    * Windows: Double click on the `.exe` file
    * Mac OSx: Unzip the osx `.zip` file, then drop Cesium into your `Applications` folder 
    * Other operating systems:  
       * Unpack the ZIP archive (file `cesium-vX.Y.Z-web.zip`) into an empty folder;
       * Open the file `index.html` in your web browser;

### On smartphone

 - Android: 
    * Manual installation: download then install the `.apk` from your smartphone;
    * [Play Store](https://play.google.com/store/apps/details?id=fr.duniter.cesium);
 - iOS
    * [App Store](https://apps.apple.com/us/app/cesium-%C4%9F1/id1471028018);


 
#### Yunohost package
    
There is a [package](https://github.com/duniter/cesium_ynh) for [YunoHost self-hosting distribution](https://yunohost.org).

## Contribute

A [Development Guide](doc/development_guide.md) is available to learn :
 - How to install your development environment.
 - Development best practices.
 
A [development tutorial](doc/fr/development_tutorial-01.md) (in French) is also available.
The [first 3 lessons of the tutorial](doc/en/development_tutorial-01.md) have also been translated into english.

## Donate

To help developers with donation, use the [Cesium Team Ğ1 account](https://demo.cesium.app#/app/wot/CitdnuQgZ45tNFCagay7Wh12gwwHM8VLej1sWmfHWnQX/) (public key: `CitdnuQgZ45tNFCagay7Wh12gwwHM8VLej1sWmfHWnQX`) 

## License

This software is distributed under [GNU AGPL-3.0](https://raw.github.com/duniter/cesium/master/LICENSE).

Please read also our [privacy policy](./doc/privacy_policy.md).