From b40d43cba0a173a2cf0c86c75b18a4729165ae67 Mon Sep 17 00:00:00 2001 From: Donny Bertucci Date: Sat, 11 Nov 2023 17:59:31 -0800 Subject: [PATCH] Update README.md --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 970eea7e..0cb9492a 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,18 @@ ![Github Actions CI tests](https://github.com/xnought/venome/actions/workflows/ci.yml/badge.svg) -A wikipedia ๐Ÿ“– for proteins. +A wikipedia ๐Ÿ“– for venom proteins: upload, search, organize, visualize, and download protein files all open source. ๐Ÿค In collaboration with the ๐Ÿงช[Venom Biochemistry & Molecular Biology Laboratory](https://venombiochemistrylab.weebly.com/) at Oregon State University ๐Ÿฆซ. -## Structure - -- [`docker-compose.yml`](./docker-compose.yml) contains the Docker container build -- [`frontend`](./frontend/README.md) contains the user interface in Svelte/JS -- [`backend`](./backend/README.md) contains the HTTP server and Database - +> **Important** +> Directories and files you'll need to know about +> - [`frontend/`](./frontend/README.md) contains the user interface in Svelte/TypeScript +> - [`backend/`](./backend/README.md) contains the backend HTTP server and Database +> - [`docs/`](./docs/README.md) contains code documention +> - [`DEVELOPMENT.md`](./docs/DEVELOPMENT.md) contains the developer getting started docs +> - [`docker-compose.yml`](./docker-compose.yml) contains the Docker container build +> - [`run.sh`](./run.sh) contains shortcut commands to develop, deploy, and test ## Quick start @@ -22,3 +24,7 @@ Go to [`DEVELOPMENT.md`](./DEVELOPMENT.md) to get up and running. - [Design Space (Figma)](https://www.figma.com/file/G1pbQsYy4lCTVCvMEnGydX/Unknown-Venome-Project?type=design&node-id=0%3A1&mode=design&t=re8tfITwMPw75A2I-1) - [Whiteboard (Figma Jam)](https://www.figma.com/file/ZKwrwzXrbwqMJUTFPF4yV0/Open-Venome-Project?type=whiteboard&node-id=0%3A1&t=DZbia2Quj2IXPhHm-1) - [Protein BioChem]() +- [SvelteKit](https://kit.svelte.dev/) +- [Svelte](https://svelte.dev/) +- [FastAPI](https://fastapi.tiangolo.com/) +