Added repository metadata.
This commit is contained in:
parent
af337ab2cf
commit
7a5db2317c
2 changed files with 48 additions and 0 deletions
31
LICENCE
Normal file
31
LICENCE
Normal file
|
@ -0,0 +1,31 @@
|
|||
Copyright (c) 2014-2016, reemo <dev.aroltd.com>
|
||||
Copyright (c) 2019-2024, flashwave <me@flash.moe>
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted (subject to the limitations in the disclaimer
|
||||
below) provided that the following conditions are met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright notice,
|
||||
this list of conditions and the following disclaimer.
|
||||
|
||||
* Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer in the
|
||||
documentation and/or other materials provided with the distribution.
|
||||
|
||||
* Neither the name of the copyright holder nor the names of its
|
||||
contributors may be used to endorse or promote products derived from this
|
||||
software without specific prior written permission.
|
||||
|
||||
NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY
|
||||
THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
|
||||
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
|
||||
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
|
||||
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
||||
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
||||
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
|
||||
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
|
||||
IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||||
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||||
POSSIBILITY OF SUCH DAMAGE.
|
17
README.md
17
README.md
|
@ -1,3 +1,20 @@
|
|||
# Ami
|
||||
|
||||
Chat client forked from the original Sock Chat client. Maintained for compatibility with Firefox 10+ and similar browsers.
|
||||
|
||||
## Configuration
|
||||
|
||||
Configuration consists of a `config.json` file that contains the various URLs and a default chat title (the unified one is taken from whatever the remote `common.json` supplies).
|
||||
Make sure you create the file before building. An example is also supplied.
|
||||
|
||||
## Building
|
||||
|
||||
Ami uses a build script written in Node.js; make sure you have NPM available and then run the following commands.
|
||||
|
||||
```sh
|
||||
# Installs packages without updating package.json or package-lock.json
|
||||
npm ci
|
||||
|
||||
# Runs the build process, make sure to run this after updates or changes as well
|
||||
node build.js
|
||||
```
|
||||
|
|
Loading…
Reference in a new issue