<commit_before>
# About **ito**

**ito** is a JavaScript library for browser-to-browser communication,
which is intended to work on devices without an input human interface
like keyboard or mouse, of course as well as PCs, smartphones and tablets.

This library is composed of two parts; application and backend interfaces.
While the backend interface can be implemented for various kinds of backend
services, only Firebase is currently supported.

"ito" is a Japanese word "糸" which means "*string*", "*thread*" or "*yarn*",
and is also an anagram of "*IoT*". 

## Copyright

Copyright (c) 2017 [KDDI Research, Inc.](http://www.kddi-research.jp)

Use of source code of this software is governed by Apache License, Version 2.0,
that can be found in [LICENSE](LICENSE) file.

# Functional Features

ito provides web applications running on browosers and web servers running on
Node.js with the following features:

* account and authentication
* friend list, as a whitelist of connectable accounts
* messaging and Notifications
* WebRTC peer-to-peer communication (browsers only)
* simple database sharing (under development)

# Prerequisites

* Browser or Node.js, compatible with ES2015(ES6)
* WebRTC compatibility (when using WebRTC peer-to-peer communication)
* A developer account for one of the following backend service(s):
  * [Firebase](https://firebase.google.com)

## Setup before using ito

### Firebase

1. Create your Firebase project at https://console.firebase.google.com.
2. Configure *Authentication -> Sign-in method*.
    * Select *Sign-in providers* as you need.
    For Facebook, *App ID*, *App secret* and *OAuth redirect URI* must be
    configured as well.
    * Add your domain to *OAuth redirect domains*.
    * Note: GitHub and Twitter are not supported yet.
3. Copy and paste `etc/firebase-rules.json` into *Database -> Rules*.
4. Confirm the snippet from *Authentication -> Web setup*, and note down
the values of `apiKey`, `authDomain` and `databaseURL`. These values are
used in `ito.init()`.

# How to run

## Loading the library on your application

Note: You can modify paths of scripts according to your environment.

### Browsers<commit_msg>minor update<commit_after>
# About **ito**

**ito** is a JavaScript library for browser-to-browser communication,
which is intended to work on devices without an input human interface
like keyboard or mouse, of course as well as PCs, smartphones and tablets.

This library is composed of two parts; application and backend interfaces.
While the backend interface can be implemented for various kinds of backend
services, only Firebase is currently supported.

"ito" is a Japanese word "糸" which means "*string*", "*thread*" or "*yarn*",
and is also an anagram of "*IoT*". 

## Copyright

Copyright (c) 2017 [KDDI Research, Inc.](http://www.kddi-research.jp)

Use of source code of this software is governed by Apache License, Version 2.0,
that can be found in [LICENSE](LICENSE) file.

# Functional Features

ito provides web applications running on browosers and web servers running on
Node.js with the following features:

* account and authentication
* friend list, as a whitelist of connectable accounts
* messaging and Notifications
* WebRTC peer-to-peer communication (browsers only)
* simple database sharing

# Prerequisites

* Browser or Node.js, compatible with ES2015(ES6)
* WebRTC compatibility (when using WebRTC peer-to-peer communication)
* A developer account for one of the following backend service(s):
  * [Firebase](https://firebase.google.com)

## Setup before using ito

### Firebase

1. Create your Firebase project at https://console.firebase.google.com.
2. Configure *Authentication -> Sign-in method*.
    * Select *Sign-in providers* as you need.
    For Facebook, *App ID*, *App secret* and *OAuth redirect URI* must be
    configured as well.
    * Add your domain to *OAuth redirect domains*.
    * Note: GitHub and Twitter are not supported yet.
3. Copy and paste `etc/firebase-rules.json` into *Database -> Rules*.
4. Confirm the snippet from *Authentication -> Web setup*, and note down
the values of `apiKey`, `authDomain` and `databaseURL`. These values are
used in `ito.init()`.

# How to run

## Loading the library on your application

Note: You can modify paths of scripts according to your environment.

### Browsers
{'fraction_non_alphanumeric': 0.08677590583891069, 'fraction_numerical': 0.006923609508423725, 'mean_word_length': 4.390547263681592, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 9, 'https://': 4, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6732022', 'n_tokens_mistral': 1203, 'n_tokens_neox': 1145, 'n_words': 570}