Skip to content

Commit f07bc7b

Browse files
committed
README update
1 parent 0b4295a commit f07bc7b

File tree

5 files changed

+23
-51
lines changed

5 files changed

+23
-51
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ function Sum({ x, y }) {
4848
<img src="https://raw.githubusercontent.com/float-toolkit/react/HEAD/media/tsftreact.svg" width="100" />
4949
</div>
5050

51-
Just like its parent package, Float Toolkit for React is written in [TypeScript](https://www.typescriptlang.org/). You can import the `ReactFT` namespace which contains all the type declarations used by the package.
51+
Just like its parent package, Float Toolkit for React is written in [TypeScript](https://www.typescriptlang.org/). The `ReactFT` namespace contains all the type definitions used by the package.
5252

5353
#### Example:
5454

@@ -84,4 +84,5 @@ Before creating an issue, please consider the following:
8484

8585
- Refer to the [FloatToolkit documentation](https://float-toolkit.web.app/) and read **this file** carefully to make sure the error is actually a bug and not a mistake of your own.
8686
- Make sure the issue hasn't already been reported or suggested.
87-
- After following these steps, you can read the [contribution guidelines](https://github.com/float-toolkit/react/blob/master/.github/CONTRIBUTING.md) and follow the steps to submit a PR.
87+
- After following these steps, you can file an issue using one of our [templates](https://github.com/float-toolkit/react/issues/new/choose). Please make sure to follow our [Code of Conduct](https://github.com/float-toolkit/react/blob/master/.github/CODE_OF_CONDUCT.md).
88+
- If you wish to [submit a pull request](https://github.com/float-toolkit/react/compare) alongside your issue, please follow our [contribution guidelines](https://github.com/float-toolkit/react/blob/master/.github/CONTRIBUTING.md).

package-lock.json

Lines changed: 16 additions & 46 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@float-toolkit/react",
3-
"version": "1.0.0",
3+
"version": "2.0.0",
44
"description": "A React hook wrapper for Float Toolkit",
55
"main": "./dist/index.js",
66
"type": "module",
@@ -11,7 +11,7 @@
1111
}
1212
},
1313
"scripts": {
14-
"build": "rm -rf dist typings && npm run format && tsc",
14+
"build": "rm -rf dist typings && node scripts/versionSync.js && npm run format && tsc",
1515
"format": "prettier --write ."
1616
},
1717
"repository": {
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
/**
22
* @internal
33
*/
4-
export const versionNumbers = ["1", "0", "0"];
4+
export const versionNumbers = ["2", "0", "0"];

src/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import { useDebugValue, useMemo, useState } from "react";
22

33
import FloatToolkit from "@float-toolkit/core";
4+
45
import { versionNumbers } from "./__autogenerated__/versionNumbers";
56

67
namespace ReactFT {

0 commit comments

Comments
 (0)