@tari-project/tarijs 0.1.20

package/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, The Tari Developer Community
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. 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.
+
+3. 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.
+
+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.

package/README.md

@@ -0,0 +1,46 @@
+# tari.js
+
+This project provides a unified TypeScript library to connect and send requests to a Tari wallet. It's intended for web application developers that want to interact with a Tari wallet (connect, get substates, submit transactions, etc.).
+
+Tari wallets supported:
+* Tari Wallet Daemon
+* MetaMask through the [tari-snap](https://github.com/tari-project/tari-snap)
+
+An example site (under the `example` folder) contains a web project that allows the user to connect to any type of Tari wallet and perform common actions.
+
+Please read the [TODO](TODO.md) file for upcoming features.
+
+## Library building
+
+You must have the [tari-dan](https://github.com/tari-project/tari-dan) repo cloned at the same folder level as this repo.
+
+To build the library:
+```shell
+npm install
+npm run build
+```
+
+The bundled files for deployment or publication will be located under the `dist` folder.
+
+## Running the example site
+
+To run the example site you will need to:
+* Compile the library following the previous section.
+* Have access to a Tari Wallet Daemon and to the Tari MetaMask Snap.
+* Copy the `example/.env.example` file to `example/.env` and edit the correct environment variable values.
+
+To run in development mode:
+```shell
+cd example
+npm install
+npm run dev
+```
+
+For building and distribution
+```shell
+cd example
+npm install
+npm run build
+```
+The distribution files will be under the `example/dist` folder. 
+