@notus-labs/patara-tokens 1.0.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 Notus Labs
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,42 @@
1
+ # Patara Tokens
2
+
3
+ Patara Tokens is a TypeScript library for verified tokens on Sui.
4
+
5
+ ## Prerequisites
6
+
7
+ Before you begin, ensure you have [Bun](https://bun.sh/) installed on your system. If you don't have Bun installed, you can download and install it by following the instructions on the [official Bun website](https://bun.sh/).
8
+
9
+ ## Installation
10
+
11
+ To install the Patara Tokens library, follow these steps:
12
+
13
+ 1. Clone the repository:
14
+
15
+ ```bash
16
+ git clone https://github.com/notus-labs/tokens.git
17
+ cd tokens
18
+ ```
19
+
20
+ 2. Install the dependencies using Bun:
21
+ ```bash
22
+ bun install
23
+ ```
24
+
25
+ ## Development
26
+
27
+ ### Available Scripts
28
+
29
+ - `bun run build`: Build the project using the custom build script
30
+ - `bun run format`: Format the code using Prettier
31
+ - `bun run lint`: Lint the code using ESLint
32
+ - `bun run prepare`: Set up Husky for Git hooks
33
+
34
+ ### Building the Library
35
+
36
+ To build the library, run:
37
+
38
+ ```bash
39
+ bun run build
40
+ ```
41
+
42
+ The build process will generate the compiled JavaScript files and TypeScript declaration files in the `dist` directory.
@@ -0,0 +1,2 @@
1
+ export * from './tokens';
2
+ export * from './types';