Skip to content

Commit f45d2ee

Browse files
erightserights
authored
docs: fix readme urls (#1480)
1 parent 7648bc7 commit f45d2ee

File tree

14 files changed

+34
-12
lines changed

14 files changed

+34
-12
lines changed

‎packages/base64/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
],
1010
"author": "Endo contributors",
1111
"license": "Apache-2.0",
12-
"homepage": "https://github.com/endojs/endo/tree/master/packages/base64#readme",
12+
"homepage": "https://github.com/endojs/endo/blob/master/packages/base64/README.md",
1313
"repository": {
1414
"type": "git",
1515
"url": "git+https://github.com/endojs/endo.git"

‎packages/cli/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"keywords": [],
66
"author": "Endo contributors",
77
"license": "Apache-2.0",
8-
"homepage": "https://github.com/endojs/endo/tree/master/packages/cli#readme",
8+
"homepage": "https://github.com/endojs/endo/blob/master/packages/cli/README.md",
99
"repository": {
1010
"type": "git",
1111
"url": "git+https://github.com/endojs/endo.git"

‎packages/daemon/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
],
99
"author": "Endo contributors",
1010
"license": "Apache-2.0",
11-
"homepage": "https://github.com/endojs/endo/tree/master/packages/daemon#readme",
11+
"homepage": "https://github.com/endojs/endo/blob/master/packages/daemon/README.md",
1212
"repository": {
1313
"type": "git",
1414
"url": "git+https://github.com/endojs/endo.git"

‎packages/exo/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1+
# `@endo/exo`
12

3+
An Exo object is an exposed Remotable object with methods (aka a Far object) which is defined with an InterfaceGuard as a protective outer layer, providing the first layer of defensiveness.
4+
5+
This `@endo/exo` package defined the APIs for making Exo objects, and for defining ExoClasses and ExoClassKits for making Exo objects.
6+
7+
See [exo-taxonomy](./docs/exo-taxonomy.md) for the taxonomy and naming conventions for the elements of this API.

‎packages/exo/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"keywords": [],
66
"author": "Endo contributors",
77
"license": "Apache-2.0",
8-
"homepage": "https://github.com/endojs/endo/tree/master/packages/exo#readme",
8+
"homepage": "https://github.com/endojs/endo/blob/master/packages/exo/README.md",
99
"repository": {
1010
"type": "git",
1111
"url": "git+https://github.com/endojs/endo.git"

‎packages/lp32/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
],
1717
"author": "Endo contributors",
1818
"license": "Apache-2.0",
19-
"homepage": "https://github.com/endojs/endo/tree/master/packages/netstring#readme",
19+
"homepage": "https://github.com/endojs/endo/blob/master/packages/lp32/README.md",
2020
"repository": {
2121
"type": "git",
2222
"url": "git+https://github.com/endojs/endo.git"

‎packages/netstring/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"keywords": [],
66
"author": "Endo contributors",
77
"license": "Apache-2.0",
8-
"homepage": "https://github.com/endojs/endo/tree/master/packages/netstring#readme",
8+
"homepage": "https://github.com/endojs/endo/blob/master/packages/netstring/README.md",
99
"repository": {
1010
"type": "git",
1111
"url": "git+https://github.com/endojs/endo.git"

‎packages/pass-style/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
# Pass-style
1+
# `@endo/pass-style`
2+
3+
Defines the `Passable` objects, and the `passStyleOf` function for classifying them according to their `PassStyle`.
4+
5+
See [types.js](./src/types.js) for the actual type definitions. See also [CopyRecord guarantees](./doc/copyRecord-guarantees.md) and [CopyArray guarantees](./doc/copyArray-guarantees.md).
6+
7+
The Passable objects are those that can be passed by the `@endo/marshal` package. Thus `Passable` defines the layer of abstraction on which we need broad agreement for interoperability. One type of `Passable` is the `Tagged` object, which is the extension point for defining higher level data types, which do not need such broad agreement. The main such higher layer of abstraction is provided by the `@endo/patterns` package.

‎packages/patterns/README.md

+10
Original file line numberDiff line numberDiff line change
@@ -1 +1,11 @@
1+
# `@endo/patterns`
12

3+
Defines new `Passable` data types and their encoding into the `Tagged` objects defined by the `@endo/pass-style` package. The `@endo/pass-style` package defines the lower level of abstraction on which we need broad agreement for interoperability. The higher level data types defined by this package include
4+
- `CopyMap`, `CopySet`, `CopyBag` -- new container types, in addition to the `CopyArrag` and `CopyRecord` already defined by `@endo/pass-style`.
5+
- a variety of Matchers, for expression patterns that can match over Passables
6+
- `Key` -- those Passables that can be keys in CopyMaps, CopySets, CopyBags, as well as MapStores and SetStores.
7+
- `Pattern` -- includes both literal pass-by-copy structures as well as Matchers. A Pattern *matches* some subset of Passable objects.
8+
9+
The main export from the package is an `M` namespace object, for making a variety of Matchers (hence "M") but also guards, such as the InterfaceGuards used by the `@endo/exo` package to serve as the first level of defense for Exo objects --- those exposed to external messages. The InterfaceGuards use patterns for enforcing type-like restrictions on the arguments and results of these potentially malicious messages.
10+
11+
See [types.js](./src/types.js) for the definitions of these new types and the methods of the exported `M` namespace object.

‎packages/patterns/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"keywords": [],
66
"author": "Endo contributors",
77
"license": "Apache-2.0",
8-
"homepage": "https://github.com/endojs/endo/tree/master/packages/patterns#readme",
8+
"homepage": "https://github.com/endojs/endo/blob/master/packages/patterns/README.md",
99
"repository": {
1010
"type": "git",
1111
"url": "git+https://github.com/endojs/endo.git"

‎packages/stream/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
],
1313
"author": "Endo contributors",
1414
"license": "Apache-2.0",
15-
"homepage": "https://github.com/endojs/endo/tree/master/packages/stream#readme",
15+
"homepage": "https://github.com/endojs/endo/blob/master/packages/stream/README.md",
1616
"repository": {
1717
"type": "git",
1818
"url": "git+https://github.com/endojs/endo.git"

‎packages/syrup/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
],
1010
"author": "Endo contributors",
1111
"license": "Apache-2.0",
12-
"homepage": "https://github.com/endojs/endo/tree/master/packages/syrup#readme",
12+
"homepage": "https://github.com/endojs/endo/blob/master/packages/syrup/README.md",
1313
"repository": {
1414
"type": "git",
1515
"url": "git+https://github.com/endojs/endo.git"

‎packages/where/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"keywords": [],
77
"author": "Endo contributors",
88
"license": "Apache-2.0",
9-
"homepage": "https://github.com/endojs/endo/tree/master/packages/where#readme",
9+
"homepage": "https://github.com/endojs/endo/blob/master/packages/where/README.md",
1010
"repository": {
1111
"type": "git",
1212
"url": "git+https://github.com/endojs/endo.git"

‎packages/zip/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
],
1010
"author": "Endo contributors",
1111
"license": "Apache-2.0",
12-
"homepage": "https://github.com/endojs/endo/tree/master/packages/zip#readme",
12+
"homepage": "https://github.com/endojs/endo/blob/master/packages/zip/README.md",
1313
"repository": {
1414
"type": "git",
1515
"url": "git+https://github.com/endojs/endo.git"

0 commit comments

Comments
 (0)