Skip to content

Commit

Permalink
add publishing section to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jdeepee committed Nov 2, 2022
1 parent b31eee5 commit 3244af7
Showing 1 changed file with 30 additions and 14 deletions.
44 changes: 30 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,28 @@

# AD4M

*The **A**gent-Centric **D**istributed **A**pplication **M**eta-ontology*
or just:
***A**gent-Centric **DA**pp **M**eta-ontology*
* A new **meta-ontology** for interoperable, decentralized application design
* A **spanning-layer** to enable seamless integration between Holochain DNAs, blockchains, linked-data structures/ontologies and centralized back-ends
* The basis for turning distinct, monolithic and siloed apps into a global, open and interoperable **sense-making network**
_The **A**gent-Centric **D**istributed **A**pplication **M**eta-ontology_
or just:
**\*A**gent-Centric **DA**pp **M**eta-ontology\*

- A new **meta-ontology** for interoperable, decentralized application design
- A **spanning-layer** to enable seamless integration between Holochain DNAs, blockchains, linked-data structures/ontologies and centralized back-ends
- The basis for turning distinct, monolithic and siloed apps into a global, open and interoperable **sense-making network**

## Repo Structure / History

This is the new mono-repository with all components making up a whole AD4M implementation merge back into what formerly was only the `ad4m-executor`.

* `core`: Former [ad4m repository](https://github.com/perspect3vism/ad4m-core-deprecated). Holds the core ontology types, the `Ad4mClient` and the GraphQL schema build automatically from the core types. This package gets published as https://www.npmjs.com/package/@perspect3vism/ad4m and is thus holding most of the app/UI facing coding.
* `executor`: All the code running inside an AD4M instance. UI-less GraphQL server, managing Agent keys, Perspectives and running Languages. TypeScript library without runnable main / executable.
* `host`: Former [ad4m-host repository](https://github.com/perspect3vism/ad4m-host). Imports and wraps executor and uses vercel/pkg to create runnable binary.
* `ui`: Former [ad4min repository](https://github.com/perspect3vism/ad4min). Tauri based system-tray icon launcher UI which is the end-user deployment including the `host` executable and providing and AD4M admin (*AD4Min*) UI interface.
- `core`: Former [ad4m repository](https://github.com/perspect3vism/ad4m-core-deprecated). Holds the core ontology types, the `Ad4mClient` and the GraphQL schema build automatically from the core types. This package gets published as https://www.npmjs.com/package/@perspect3vism/ad4m and is thus holding most of the app/UI facing coding.
- `executor`: All the code running inside an AD4M instance. UI-less GraphQL server, managing Agent keys, Perspectives and running Languages. TypeScript library without runnable main / executable.
- `host`: Former [ad4m-host repository](https://github.com/perspect3vism/ad4m-host). Imports and wraps executor and uses vercel/pkg to create runnable binary.
- `ui`: Former [ad4min repository](https://github.com/perspect3vism/ad4min). Tauri based system-tray icon launcher UI which is the end-user deployment including the `host` executable and providing and AD4M admin (_AD4Min_) UI interface.

---
* `connect`: Former [ad4m-connect repository](https://github.com/perspect3vism/ad4m-connect). Convenience library to connect to a (local or via proxy) AD4M-executor, potentially requesting or reusing capability tokens and creating an `Ad4mClient` ready for the app/UI to use.
* `docs-src` / `docs`: Documentation hosted under https://docs.ad4m.dev


- `connect`: Former [ad4m-connect repository](https://github.com/perspect3vism/ad4m-connect). Convenience library to connect to a (local or via proxy) AD4M-executor, potentially requesting or reusing capability tokens and creating an `Ad4mClient` ready for the app/UI to use.
- `docs-src` / `docs`: Documentation hosted under https://docs.ad4m.dev

The project started in August 2020 in https://github.com/lucksus/perspectivism, then got broken down into the `ad4m` (core), `ad4m-executor` and [perspect3ve](https://github.com/perspect3vism/perspect3ve) repositories for simultaneuous use in [Flux](https://github.com/fluxsocial) and Perspect3ve. Other components got added over the years 2021, 2022.

In October/November 2022, these componentes were collected into a mono-repo again to avoid PR-chains across multiple repositories and to have version numbers be in lock-step.
Expand All @@ -35,4 +38,17 @@ In October/November 2022, these componentes were collected into a mono-repo agai
yarn install
yarn build
yarn test
```
```

## Publishing

Before making a PR with a set of changes, run the following command on your branch:

```
yarn changeset
```

This command will allow you to create a new set of changes, any associate them to given packages, for which you can decide if a major or minor version increment should be made.
<br>

Once your PR is merged into main, the yarn changeset publish script will be ran and your changes uploaded to npm in accordance with the version detailed in the changeset.

0 comments on commit 3244af7

Please sign in to comment.