@intrig/react 0.0.1 → 1.0.6

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 (13) hide show
  1. package/README.md +17 -66
  2. package/index.esm.js +807 -363
  3. package/package.json +7 -3
  4. package/src/extra/index.d.ts +4 -0
  5. package/src/extra/useAsNetworkState.d.ts +13 -0
  6. package/src/extra/useAsPromise.d.ts +59 -0
  7. package/src/extra/useResolvedCachedValue.d.ts +54 -0
  8. package/src/extra/useResolvedValue.d.ts +50 -0
  9. package/src/index.d.ts +2 -0
  10. package/src/intrig-context.d.ts +2 -2
  11. package/src/intrig-provider.d.ts +8 -7
  12. package/src/media-type-utils.d.ts +3 -0
  13. package/src/network-state.d.ts +164 -26
package/README.md CHANGED
@@ -1,82 +1,33 @@
1
1
  # Intrig
2
2
 
3
- <a alt="Nx logo" href="https://nx.dev" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="45"></a>
3
+ Intrig is a powerful tool for simplifying API integration in React applications. It provides enhanced documentation, API version management, and developer tooling for seamless frontend-backend integration.
4
4
 
5
- ✨ Your new, shiny [Nx workspace](https://nx.dev) is almost ready ✨.
5
+ ## Getting Started
6
6
 
7
- [Learn more about this workspace setup and its capabilities](https://nx.dev/nx-api/node?utm_source=nx_project&amp;utm_medium=readme&amp;utm_campaign=nx_projects) or run `npx nx graph` to visually explore what was created. Now, let's get you up to speed!
7
+ Prerequisites
8
8
 
9
- ## Finish your CI setup
9
+ * Node.js v16+.
10
+ * Nx build tool.
10
11
 
11
- [Click here to finish setting up your workspace!](https://cloud.nx.app/connect/e4mOmAhulO)
12
+ ## Installation
12
13
 
14
+ Clone the repository and install dependencies:
13
15
 
14
- ## Run tasks
16
+ ```bash
17
+ $ git clone https://github.com/your-username/intrig.git
18
+ $ cd intrig
19
+ $ npm install
15
20
 
16
- To run the dev server for your app, use:
17
-
18
- ```sh
19
- npx nx serve intrig
20
- ```
21
-
22
- To create a production bundle:
23
-
24
- ```sh
25
- npx nx build intrig
26
- ```
27
-
28
- To see all available targets to run for a project, run:
29
-
30
- ```sh
31
- npx nx show project intrig
32
21
  ```
33
22
 
34
- These targets are either [inferred automatically](https://nx.dev/concepts/inferred-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) or defined in the `project.json` or `package.json` files.
35
-
36
- [More about running tasks in the docs &raquo;](https://nx.dev/features/run-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
37
-
38
- ## Add new projects
39
-
40
- While you could add new projects to your workspace manually, you might want to leverage [Nx plugins](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) and their [code generation](https://nx.dev/features/generate-code?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) feature.
41
-
42
- Use the plugin's generator to create new projects.
43
-
44
- To generate a new application, use:
45
-
46
- ```sh
47
- npx nx g @nx/node:app demo
48
- ```
49
-
50
- To generate a new library, use:
51
-
52
- ```sh
53
- npx nx g @nx/node:lib mylib
54
- ```
55
-
56
- You can use `npx nx list` to get a list of installed plugins. Then, run `npx nx list <plugin-name>` to learn about more specific capabilities of a particular plugin. Alternatively, [install Nx Console](https://nx.dev/getting-started/editor-setup?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) to browse plugins and generators in your IDE.
57
-
58
- [Learn more about Nx plugins &raquo;](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) | [Browse the plugin registry &raquo;](https://nx.dev/plugin-registry?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
59
-
60
-
61
- [Learn more about Nx on CI](https://nx.dev/ci/intro/ci-with-nx#ready-get-started-with-your-provider?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
62
-
63
- ## Install Nx Console
64
-
65
- Nx Console is an editor extension that enriches your developer experience. It lets you run tasks, generate code, and improves code autocompletion in your IDE. It is available for VSCode and IntelliJ.
23
+ ## License
66
24
 
67
- [Install Nx Console &raquo;](https://nx.dev/getting-started/editor-setup?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
25
+ Intrig is open source software licensed under the [MIT License](LICENSE).
68
26
 
69
- ## Useful links
27
+ ## Contribution
70
28
 
71
- Learn more:
29
+ We welcome contributions! Please read our [contributing guide](CONTRIBUTING.md) to learn how you can get involved.
72
30
 
73
- - [Learn more about this workspace setup](https://nx.dev/nx-api/node?utm_source=nx_project&amp;utm_medium=readme&amp;utm_campaign=nx_projects)
74
- - [Learn about Nx on CI](https://nx.dev/ci/intro/ci-with-nx?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
75
- - [Releasing Packages with Nx release](https://nx.dev/features/manage-releases?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
76
- - [What are Nx plugins?](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
31
+ ## Contact
77
32
 
78
- And join the Nx community:
79
- - [Discord](https://go.nx.dev/community)
80
- - [Follow us on X](https://twitter.com/nxdevtools) or [LinkedIn](https://www.linkedin.com/company/nrwl)
81
- - [Our Youtube channel](https://www.youtube.com/@nxdevtools)
82
- - [Our blog](https://nx.dev/blog?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
33
+ For questions or feedback, feel free to reach out at [support@intrigsoft.com](mailto\:support@intrigsoft.com).