fluid-framework 2.0.0-rc.1.0.1 → 2.0.0-rc.1.0.2

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 (2) hide show
  1. package/README.md +30 -48
  2. package/package.json +8 -8
package/README.md CHANGED
@@ -1,25 +1,30 @@
1
- # @fluidframework/cell
1
+ # fluid-framework
2
2
 
3
- The `SharedCell` Distributed Data Structure (DDS) stores a single, shared value that can be edited or deleted.
3
+ The `fluid-framework` package bundles a collection of Fluid Framework client libraries for easy use when paired with a corresponding service client package (e.g. `@fluidframework/azure-client`, `@fluidframework/tinylicious-client`, or `@fluid-experimental/osdp-client (BETA)`).
4
4
 
5
- <!-- AUTO-GENERATED-CONTENT:START (README_INSTALLATION_SECTION:includeHeading=TRUE) -->
5
+ ## Contents
6
6
 
7
- <!-- prettier-ignore-start -->
8
- <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
7
+ The `fluid-framework` package consists primarily of two portions: the `IFluidContainer` and a selection of distributed data structures (DDSes).
9
8
 
10
- ## Installation
9
+ ### IFluidContainer
11
10
 
12
- To get started, install the package by running the following command:
11
+ The **[IFluidContainer][]** interface is the one of the types returned by calls to `createContainer()` and `getContainer()` on the service clients such as `AzureClient`.
12
+ It includes functionality to retrieve the Fluid data contained within, as well as to inspect the state of the collaboration session connection.
13
13
 
14
- ```bash
15
- npm i fluid-framework
16
- ```
14
+ ### DDS packages
17
15
 
18
- <!-- prettier-ignore-end -->
16
+ You'll use one or more DDS data structures in your container to model your collaborative data.
17
+ The `fluid-framework` package offers the following data structures:
19
18
 
20
- <!-- AUTO-GENERATED-CONTENT:END -->
19
+ 1. **[SharedTree][]**
20
+ 1. **[SharedMap][]**, a map-like data structure for storing key/value pair data
21
+ - Note: as of version 2.0, `SharedMap` is deprecated. Please use `SharedTree` instead.
21
22
 
22
- <!-- AUTO-GENERATED-CONTENT:START (README_DEPENDENCY_GUIDELINES_SECTION:includeHeading=TRUE) -->
23
+ ## Tutorial
24
+
25
+ Check out the Hello World tutorial using the `fluid-framework` package [here](https://fluidframework.com/docs/start/tutorial/).
26
+
27
+ <!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README:scripts=FALSE) -->
23
28
 
24
29
  <!-- prettier-ignore-start -->
25
30
  <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
@@ -30,28 +35,17 @@ When taking a dependency on a Fluid Framework library, we recommend using a `^`
30
35
  While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
31
36
  library consumers should always prefer `^`.
32
37
 
33
- <!-- prettier-ignore-end -->
34
-
35
- <!-- AUTO-GENERATED-CONTENT:END -->
36
-
37
- <!-- AUTO-GENERATED-CONTENT:START (README_API_DOCS_SECTION:includeHeading=TRUE) -->
38
+ ## Installation
38
39
 
39
- <!-- prettier-ignore-start -->
40
+ To get started, install the package by running the following command:
40
41
 
41
- <!-- This section is automatically generated. To update it, make the appropriate changes to docs/md-magic.config.js or the embedded content, then run 'npm run build:md-magic' in the docs folder. -->
42
+ ```bash
43
+ npm i fluid-framework
44
+ ```
42
45
 
43
46
  ## API Documentation
44
47
 
45
- API documentation for **@fluidframework/cell** is available at <https://fluidframework.com/docs/api/v1/cell>.
46
-
47
- <!-- prettier-ignore-end -->
48
-
49
- <!-- AUTO-GENERATED-CONTENT:END -->
50
-
51
- <!-- AUTO-GENERATED-CONTENT:START (README_CONTRIBUTION_GUIDELINES_SECTION:includeHeading=TRUE) -->
52
-
53
- <!-- prettier-ignore-start -->
54
- <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
48
+ API documentation for **fluid-framework** is available at <https://fluidframework.com/docs/apis/fluid-framework>.
55
49
 
56
50
  ## Contribution Guidelines
57
51
 
@@ -71,15 +65,6 @@ This project may contain Microsoft trademarks or logos for Microsoft projects, p
71
65
  Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
72
66
  Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
73
67
 
74
- <!-- prettier-ignore-end -->
75
-
76
- <!-- AUTO-GENERATED-CONTENT:END -->
77
-
78
- <!-- AUTO-GENERATED-CONTENT:START (README_HELP_SECTION:includeHeading=TRUE) -->
79
-
80
- <!-- prettier-ignore-start -->
81
- <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
82
-
83
68
  ## Help
84
69
 
85
70
  Not finding what you're looking for in this README? Check out our [GitHub
@@ -90,15 +75,6 @@ issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feat
90
75
 
91
76
  Thank you!
92
77
 
93
- <!-- prettier-ignore-end -->
94
-
95
- <!-- AUTO-GENERATED-CONTENT:END -->
96
-
97
- <!-- AUTO-GENERATED-CONTENT:START (README_TRADEMARK_SECTION:includeHeading=TRUE) -->
98
-
99
- <!-- prettier-ignore-start -->
100
- <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
101
-
102
78
  ## Trademark
103
79
 
104
80
  This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
@@ -110,3 +86,9 @@ Use of Microsoft trademarks or logos in modified versions of this project must n
110
86
  <!-- prettier-ignore-end -->
111
87
 
112
88
  <!-- AUTO-GENERATED-CONTENT:END -->
89
+
90
+ <!-- Links -->
91
+
92
+ [ifluidcontainer]: https://fluidframework.com/docs/api/v2/fluid-framework/ifluidcontainer-interface
93
+ [sharedmap]: https://fluidframework.com/docs/data-structures/map/
94
+ [sharedtree]: https://fluidframework.com/docs/data-structures/tree/
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "fluid-framework",
3
- "version": "2.0.0-rc.1.0.1",
3
+ "version": "2.0.0-rc.1.0.2",
4
4
  "description": "The main entry point into Fluid Framework public packages",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -67,13 +67,13 @@
67
67
  "module": "lib/index.mjs",
68
68
  "types": "dist/index.d.ts",
69
69
  "dependencies": {
70
- "@fluidframework/container-definitions": ">=2.0.0-rc.1.0.1 <2.0.0-rc.1.1.0",
71
- "@fluidframework/container-loader": ">=2.0.0-rc.1.0.1 <2.0.0-rc.1.1.0",
72
- "@fluidframework/driver-definitions": ">=2.0.0-rc.1.0.1 <2.0.0-rc.1.1.0",
73
- "@fluidframework/fluid-static": ">=2.0.0-rc.1.0.1 <2.0.0-rc.1.1.0",
74
- "@fluidframework/map": ">=2.0.0-rc.1.0.1 <2.0.0-rc.1.1.0",
75
- "@fluidframework/sequence": ">=2.0.0-rc.1.0.1 <2.0.0-rc.1.1.0",
76
- "@fluidframework/tree": ">=2.0.0-rc.1.0.1 <2.0.0-rc.1.1.0"
70
+ "@fluidframework/container-definitions": ">=2.0.0-rc.1.0.2 <2.0.0-rc.1.1.0",
71
+ "@fluidframework/container-loader": ">=2.0.0-rc.1.0.2 <2.0.0-rc.1.1.0",
72
+ "@fluidframework/driver-definitions": ">=2.0.0-rc.1.0.2 <2.0.0-rc.1.1.0",
73
+ "@fluidframework/fluid-static": ">=2.0.0-rc.1.0.2 <2.0.0-rc.1.1.0",
74
+ "@fluidframework/map": ">=2.0.0-rc.1.0.2 <2.0.0-rc.1.1.0",
75
+ "@fluidframework/sequence": ">=2.0.0-rc.1.0.2 <2.0.0-rc.1.1.0",
76
+ "@fluidframework/tree": ">=2.0.0-rc.1.0.2 <2.0.0-rc.1.1.0"
77
77
  },
78
78
  "devDependencies": {
79
79
  "@arethetypeswrong/cli": "^0.13.3",