dredless 1.0.0 → 1.0.1
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.
- package/README.md +11 -12
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# dredless
|
|
2
2
|
|
|
3
|
-
A headless
|
|
3
|
+
A headless pure Javascript (with type annotations) implementation of [drednot.io](https://drednot.io)'s client protocol.
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
@@ -26,19 +26,18 @@ const ships = await session.fetchShips(server);
|
|
|
26
26
|
console.log(ships.map(({name, hexCode, playerCount}) => ({name, hexCode, playerCount})));
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
-
This reads the ship list without opening a game connection. Supplying `DREDNOT_ANON_KEY` reuses an anonymous identity; omitting it creates one.
|
|
29
|
+
This reads the ship list without opening a game connection. Supplying `DREDNOT_ANON_KEY` reuses an anonymous identity; omitting it creates one.
|
|
30
|
+
[Session setup](docs/NODE_API.md#authentication-and-reuse) explains how to reuse anonymous or registered accounts.
|
|
30
31
|
|
|
31
32
|
## Documentation
|
|
32
33
|
|
|
33
34
|
Start with the [documentation index](docs/README.md).
|
|
34
35
|
|
|
35
|
-
| Task
|
|
36
|
-
|
|
37
|
-
| Connect and read a live ship
|
|
38
|
-
| Authenticate in Node
|
|
39
|
-
| Use browser cookies or an existing socket | [Browser setup](docs/BROWSER_API.md)
|
|
40
|
-
| Find a method or type
|
|
41
|
-
| Understand callbacks and completion
|
|
42
|
-
| Diagnose missing state or failed actions
|
|
43
|
-
|
|
44
|
-
Docs describe this checkout. A published npm version or CDN bundle can have fewer methods; use documentation from the corresponding release when working with an older version.
|
|
36
|
+
| Task | Guide |
|
|
37
|
+
|-------------------------------------------|-------------------------------------------------------|
|
|
38
|
+
| Connect and read a live ship | [Getting started](docs/GETTING_STARTED.md) |
|
|
39
|
+
| Authenticate in Node | [Node sessions](docs/NODE_API.md) |
|
|
40
|
+
| Use browser cookies or an existing socket | [Browser setup](docs/BROWSER_API.md) |
|
|
41
|
+
| Find a method or type | [API reference](docs/API_REFERENCE.md) |
|
|
42
|
+
| Understand callbacks and completion | [Lifecycle](docs/CLIENT.md), [events](docs/EVENTS.md) |
|
|
43
|
+
| Diagnose missing state or failed actions | [Troubleshooting](docs/TROUBLESHOOTING.md) |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "dredless",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "A fully-featured and from-scratch headless drednot.io client implementation written in pure js.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://github.com/certainhuman/dredless#readme",
|