Skip to content

Commit

Permalink
Merge pull request #145 from FabricLabs/feature/v0.1.0-RC1
Browse files Browse the repository at this point in the history
Documentation Pass
  • Loading branch information
martindale authored May 15, 2024
2 parents f6b6e0c + ecac597 commit d44f6c4
Show file tree
Hide file tree
Showing 12 changed files with 231 additions and 290 deletions.
32 changes: 32 additions & 0 deletions MESSAGES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Fabric Messages

```
TYPE|NAME
====|====
0000|
0001|GENERIC_MESSAGE
0002|PEER_ANNOUNCE
0003|PEER_PING
0004|PEER_PONG
0005|
0006|
0007|
0008|
0009|
000a|
000b|
000c|
000d|
000e|
000f|
0010|
001f| # 31
0020| # 32
0021|BITCOIN_BLOCK_HASH
0022|BITCOIN_TRANSACTION_HASH
002f| # 47
0030| # 48
0031|FABRIC_STATE
0032|FABRIC_DOCUMENT
0033|FABRIC_DELTA
```
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,14 +108,12 @@ main().catch((exception) => {
## Plugins
Fabric is an extensible framework, supporting a variety of plugins.

| Package | Description | Status |
|------------------------------------|--------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
| [`@fabric/http`][http-plugin] | serve Fabric apps to the legacy web (HTTP) | [![Build Status][badge-http-status]][http-test-status] [![Coverage Status][badge-http-coverage]][badge-http-coverage] |
| [`@fabric/github`][github-plugin] | interact with GitHub through Fabric | [![Build Status][badge-github-status]][github-test-status] [![Coverage Status][badge-github-coverage]][github-coverage-home] |
| [`@fabric/matrix`][matrix-plugin] | connect to Matrix servers | [![Build Status][badge-matrix-status]][matrix-test-status] [![Coverage Status][badge-matrix-coverage]][badge-matrix-coverage] |
| [`@fabric/twilio`][twilio-plugin] | send (and receive) SMS and phone calls | [![Build Status][badge-twilio-status]][twilio-test-status] [![Coverage Status][badge-twilio-coverage]][badge-twilio-coverage] |
| [`@fabric/zapier`][zapier-plugin] | interact with arbitrary zapier triggers | [![Build Status][badge-zapier-status]][zapier-test-status] [![Coverage Status][badge-zapier-coverage]][badge-zapier-coverage] |
| [`@fabric/doorman`][doorman] | an artificially intelligent assistant | [![Build Status][badge-doorman-status]][doorman-test-status] [![Coverage Status][badge-doorman-coverage]][doorman-coverage-home] |
| Package | Description | Status |
|------------------------------------|--------------------------------------------|----------------------------------------------------------------------|
| [`@fabric/http`][http-plugin] | serve Fabric apps to the legacy web (HTTP) | [![Coverage Status][badge-http-coverage]][badge-http-coverage] |
| [`@fabric/hub`][hub-plugin] | run your own Fabric Hub | [![Coverage Status][badge-hub-coverage]][badge-hub-coverage] |
| [`@fabric/matrix`][matrix-plugin] | connect to Matrix servers | [![Coverage Status][badge-matrix-coverage]][badge-matrix-coverage] |
| [`@fabric/doorman`][doorman] | an artificially intelligent assistant | [![Coverage Status][badge-doorman-coverage]][doorman-coverage-home] |

## Running on Fabric
Several successful projects are built with or are running on Fabric, including:
Expand Down Expand Up @@ -146,6 +144,9 @@ Either Fabric libraries or projects running Fabric, this list encompasses the mo
| [`hub.fabric.pub`](https://hub.fabric.pub) |
| [`labs.fabric.pub`](https://labs.fabric.pub) |
| [`grove.chat`][chat] |
| `sensemaker.io` | | | `FALSE`
| `verse.pub`
| `trynovo.com` | | | `FALSE`

## Learning More
The best place to get started is in [the #learning channel][learning], a
Expand Down
3 changes: 3 additions & 0 deletions contracts/trace.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
module.exports = function OP_TRACE (obj = {}) {
// console.log('[TRACE] Starting trace...');
// console.log('[TRACE] Runtime:', this);
// console.log('[TRACE] obj:', obj);
Error.captureStackTrace(obj, OP_TRACE);
return `@\n${obj.stack.split('\n').slice(1).join('\n')}`;
};
2 changes: 1 addition & 1 deletion examples/app.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
// This example is intended for downstream consumers — those seeking to implement client-facing applications using Fabric.
//
// ## Quickstart
// Ensure that you are using NodeJS `16.17.1` — execute in your clone of the Fabric Core repository.
// Ensure that you are using NodeJS `18.19.0` — execute in your clone of the Fabric Core repository.
//
// ### Cloning Fabric
// Run the following commands:
Expand Down
Loading

0 comments on commit d44f6c4

Please sign in to comment.