Skip to content

Commit

Permalink
Remove old information from README
Browse files Browse the repository at this point in the history
  • Loading branch information
JR40159 committed Oct 23, 2024
1 parent e2bdeb3 commit 6a99d7f
Showing 1 changed file with 2 additions and 33 deletions.
35 changes: 2 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@
<li><a href="#installation">Installation</a></li>
</ul>
</li>
<li><a href="#roadmap">Roadmap</a></li>
<li><a href="#usage">Usage</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#breaking">Breaking Changes</a></li>
Expand Down Expand Up @@ -79,7 +78,7 @@ sharing.

### Requirements:

- Node v18
- Node v22
- Docker / Docker Compose

<br />
Expand Down Expand Up @@ -117,21 +116,6 @@ JWKS file for the public key referenced in the backend application configuration

<br />

### Setup:

Some example schemas are installed by default. More schemas can be added by altering and running the
`addDeploymentSchema.ts` and `addUploadSchema.ts` files.

```bash
npm run script -- addDeploymentSchema
npm run script -- addUploadSchema
```

> NOTE: Scripts are also written in Typescript. In production, run them using `node`, in development, run them using
> `tsx` or `npm run script`.
<br />

### Service Ports:

| Service | Host | Notes |
Expand Down Expand Up @@ -170,10 +154,6 @@ You can test out your new deployment using the example models which can be found
is an array with all items being middleware except the last, which is the handler (`[...middleware, handler]`).
4. Routes interact with the database via `mongoose`, which stores models in `./backend/models`.

Some processing is done away from the main thread, when it is expected to take longer than a few milliseconds. These are
posted to a `mongodb` queue and processed by handlers in the `backend/processors` folder. Mongodb queues are handled
invisibly by `p-mongo-queue` (`backend/utils/queues.ts`).

<br />

### Known Issues
Expand All @@ -194,20 +174,9 @@ application is able to access the Docker registry internally as it will not prov

<br />

### Roadmap

List of near term goals:

- Model metrication
- Instance federation

<br />

<!-- USAGE EXAMPLES -->

## Usage

See [our user documentation](https://gchq.github.io/Bailo/docs/users/upload-a-model/why-upload-a-model)
See [our user documentation](https://gchq.github.io/Bailo/docs)

<br />

Expand Down

0 comments on commit 6a99d7f

Please sign in to comment.