Skip to content

Commit 1af133c

Browse files
committed
docs: update readme
1 parent 1ae84b3 commit 1af133c

3 files changed

Lines changed: 48 additions & 48 deletions

File tree

.github/workflows/semantic-release.yml

Lines changed: 0 additions & 27 deletions
This file was deleted.

.yarnrc.yml

Lines changed: 0 additions & 1 deletion
This file was deleted.

README.md

Lines changed: 48 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,40 @@
11
<div align="center">
22

3-
<h1>posters.science Documentation</h1>
3+
<img src="https://cdn.posters.science/logos/poster-fairy.png" alt="Posters.science logo" title="This image was generated by AI" width="200" height="auto" />
4+
5+
<br />
6+
7+
<h1>Posters.science</h1>
8+
9+
<p>
10+
A free, open-source platform for sharing, discovering, and citing scientific posters.
11+
</p>
12+
13+
<br />
414

515
<p>
6-
Documentation for posters.science.
16+
<a href="https://github.com/fairdataihub/posters-science/graphs/contributors">
17+
<img src="https://img.shields.io/github/contributors/fairdataihub/posters-science.svg?style=flat-square" alt="contributors" />
18+
</a>
19+
<a href="https://github.com/fairdataihub/posters-science/stargazers">
20+
<img src="https://img.shields.io/github/stars/fairdataihub/posters-science.svg?style=flat-square" alt="stars" />
21+
</a>
22+
<a href="https://github.com/fairdataihub/posters-science/issues/">
23+
<img src="https://img.shields.io/github/issues/fairdataihub/posters-science.svg?style=flat-square" alt="open issues" />
24+
</a>
25+
<a href="https://github.com/fairdataihub/posters-science/blob/main/LICENSE">
26+
<img src="https://img.shields.io/github/license/fairdataihub/posters-science.svg?style=flat-square" alt="license" />
27+
</a>
728
</p>
829

930
<h4>
10-
<a href="https://github.com/fairdataihub/posters-science-docs/issues/">Report Issues/Make suggestions</a>
31+
<a href="https://posters.science">Website</a>
32+
<span> · </span>
33+
<a href="https://dev.posters.science">Developer Docs</a>
34+
<span> · </span>
35+
<a href="https://github.com/fairdataihub/posters-science/issues/">Report Bug</a>
36+
<span> · </span>
37+
<a href="https://github.com/fairdataihub/posters-science/issues/">Request Feature</a>
1138
</h4>
1239
</div>
1340

@@ -17,32 +44,33 @@ Documentation for posters.science.
1744

1845
## About
1946

20-
This repository contains the documentation for posters.science.
47+
Posters.science is a platform for researchers to upload, share, and discover scientific conference posters. When a poster is uploaded, the platform automatically extracts structured metadata such as titles, authors, affiliations, sections, and figure captions. This makes posters findable, citable, and machine-readable.
2148

22-
## Developer Instructions
49+
The platform is built around [FAIR principles](https://www.go-fair.org/fair-principles/) (Findable, Accessible, Interoperable, Reusable) and integrates with [Zenodo](https://zenodo.org/) so that posters can be deposited with a DOI for long-term archival and citation.
2350

24-
### Prerequisites
51+
Posters.science is developed by the [FAIR Data Innovations Hub](https://fairdataihub.org/) at the [California Medical Innovations Institute (CalMI2)](https://calmi2.org/).
2552

26-
This project uses `yarn` as the package manager.
53+
## Getting Started
2754

28-
```bash
29-
npm install -g yarn
30-
```
31-
32-
### Run Locally
55+
**Prerequisites:** Mise to handle the node and pnpm installation.
3356

3457
```bash
35-
git clone https://github.com/fairdataihub/posters-science-docs.git
36-
cd posters-science-docs
37-
yarn install
38-
yarn dev
58+
mise trust # only needed the first time to trust this repository
59+
mise install
60+
61+
pnpm install
62+
pnpm dev
3963
```
4064

41-
### Build Locally
65+
The site will be available at `http://localhost:3000`.
4266

43-
```bash
44-
yarn docs:build
45-
```
67+
## Scripts
68+
69+
| Command | Description |
70+
| ------------------- | ------------------------ |
71+
| `pnpm dev` | Start local dev server |
72+
| `pnpm docs:build` | Build for production |
73+
| `pnpm docs:preview` | Preview production build |
4674

4775
## License
4876

0 commit comments

Comments
 (0)