first iteration of readme file

This commit is contained in:
Nicolas Constant 2018-09-20 21:01:21 -04:00 committed by GitHub
parent 5f306ef854
commit 0e97c59650
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 34 additions and 3 deletions

View File

@ -1,6 +1,37 @@
# Intro
Sengi is a dekstop mastodon client.
[![AppVeyor master](https://img.shields.io/appveyor/ci/NicolasConstant/sengi/master.svg?style=flat-square)](https://img.shields.io/appveyor/ci/NicolasConstant/sengi/master.svg) ![AppVeyor tests master](https://img.shields.io/appveyor/tests/nicolasconstant/sengi/master.svg?style=flat-square) [![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg?style=flat-square)](https://www.gnu.org/licenses/agpl-3.0)
## Introduction
Sengi is a **Mastodon** and **Pleroma** desktop focused client. It takes inspiration from the old Tweetdeck [client](https://static.makeuseof.com/wp-content/uploads/2012/02/muo-tweetdeck2b.png), the new Tweetdeck webapp and Mastodon UI.
Focus will be made on the following points:
* Heavily oriented on multi-accounts usage
* Desktop based interactions (right clic, left clic, etc)
* One column at a time display (leaves it on the side of your screen, and keep an eye on it while doing your other stuff)
It will be released as a **browser webapp** and also packaged as an **cross-platform desktop application** (Mac, Windows, and Linux).
## Fediverse accounts
* [Official Sengi Account](https://mastodon.social/@sengi_app)
## What's a sengi?!
It's a little [elephant shrew](https://en.wikipedia.org/wiki/Elephant_shrew) from Africa:
![Rhynchocyon petersi](https://upload.wikimedia.org/wikipedia/commons/thumb/8/81/Rhynchocyon_petersi_from_side.jpg/400px-Rhynchocyon_petersi_from_side.jpg)
## License
MIT
This project is licensed under the AGPLv3 License - see LICENSE file for details
## Dependencies
* [Angular 6](https://github.com/angular/angular)
* [NGXS](https://github.com/ngxs/store)
* [SASS](https://github.com/sass/dart-sass)
* [Electron](https://github.com/electron/electron)