This repository has been archived on 2023-09-20. You can view files and clone it, but cannot push or open issues or pull requests.
chromesoul/README.md

35 lines
2.1 KiB
Markdown
Raw Normal View History

2012-10-17 23:04:31 +02:00
## What is chromesoul?
2012-10-17 22:31:04 +02:00
2012-10-17 23:31:58 +02:00
Chromesoul is a minimalist NetSoul client for Google Chrome. It aim to connect to the NetSoul server and stay active, but does not provide all the functionalities you can expect from a real client.
2012-10-17 23:04:31 +02:00
## Why?
2012-10-21 23:18:55 +02:00
When you're on the PIE, you're stuck in it unless you are connected to netsoul, and with multiple boot and mobile devices it's a real pain to configure many NetSoul clients. That's why chromesoul is awesome: not only it's a cross-platform NS client, but with the Chrome synchronisation it's automaticaly installed and configured.
2012-10-17 23:04:31 +02:00
2012-10-21 12:42:48 +02:00
## Requirements
Sockets have been introduced in Chromium 24. Therefore, it is required to have a web-browser based on Chromium 24 or newer. At the time of writing, it's available on the [dev early release channel](http://www.chromium.org/getting-involved/dev-channel). For more informations, please refer to the [Chromium development calendar and release info](http://dev.chromium.org/developers/calendar).
2012-10-17 23:04:31 +02:00
## Features
### Password encryption
2012-10-21 23:18:55 +02:00
Storing your socks password encrypted is a priority but is not available yet. Yes, the chromesoul dev version is unsafe; so is the official NetSoul server which doesn't store a hash but the password itself (it's a requirement from the NetSoul protocol).
2012-10-17 23:04:31 +02:00
### Messages
2012-10-21 23:18:55 +02:00
Because the only purpose of this extension is to provide an access to internet when you're on the PIE, there is no plan to support messages at this time. Thoses stupid guys who have fun spamming everyone by broadcasting messages are the second reasons why you won't see any message using chromesoul. Maybe one day I'll write a chat interface, however it will be unobtrusive.
### Contacts
If you cannot send and receive messages, you don't need a contact list.
2012-10-17 23:31:58 +02:00
2012-10-21 23:18:55 +02:00
### State change
Same as contacts. Why changing your state if you're not gonna talk?
2012-10-17 23:31:58 +02:00
## Licence
Chromesoul is released under an [ISC licence](http://en.wikipedia.org/wiki/ISC_license "ISC licence"). See the LICENCE.txt file for more details.
2012-10-21 12:59:38 +02:00
Chromesoul uses third-party free softwares which belongs to their respective owners. Such softwares are listed in the CREDITS.md file.