tgui-core 1.0.16 → 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.
Files changed (3) hide show
  1. package/README.md +9 -3
  2. package/license.txt +21 -0
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -7,20 +7,26 @@ This package was built to help the various downstream SS13 servers stay up to da
7
7
  You can view the code on [GitHub](https://github.com/jlsnow301/tgui-core).
8
8
 
9
9
  ## Installation
10
-
10
+ (assuming you have a tgui folder, navigate to the specific package)
11
11
  ```sh
12
+ cd tgui/packages/tgui
12
13
  yarn add tgui-core
13
14
  ```
14
15
 
15
16
  ## Usage
16
17
 
17
18
  ```tsx
18
- import { Button } from 'tgui-core/components/Button';
19
- import { render } from 'tgui-core/render';
19
+ import { Button } from 'tgui-core/components';
20
20
 
21
21
  <Button>Click</Button>;
22
22
  ```
23
23
 
24
+ You can even use it in tandem with your own in house TGUI components,
25
+ ```tsx
26
+ import { Button } from 'tgui-core/components';
27
+ import { Box } from '../components';
28
+ ```
29
+
24
30
  ## License
25
31
 
26
32
  MIT
package/license.txt ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 TG Station
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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tgui-core",
3
- "version": "1.0.16",
3
+ "version": "1.0.17",
4
4
  "description": "TGUI core component library",
5
5
  "keywords": [
6
6
  "TGUI",