README.md 2.71 KB
Newer Older
Richard Smith-Unna's avatar
Richard Smith-Unna committed
1
<div width="100%" align="center">
Jure's avatar
Jure committed
2
3
  <img src="https://gitlab.coko.foundation/pubsweet/pubsweet/raw/master/assets/logo-pubsweet.png" width="300" />
  <h2>PubSweet: The open toolkit for building publishing workflows</h2>
Richard Smith-Unna's avatar
Richard Smith-Unna committed
4
</div>
Jure's avatar
Jure committed
5

Jure's avatar
Jure committed
6
7
| [![MIT license](https://img.shields.io/badge/license-MIT-e51879.svg)](https://gitlab.coko.foundation/pubsweet/pubsweet/raw/master/LICENSE) [![mattermost](https://img.shields.io/badge/mattermost_chat-coko%2Fpubsweet-blue.svg)](https://mattermost.coko.foundation/coko/channels/pubsweet) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) |
| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
8

Jure's avatar
Jure committed
9

Richard Smith-Unna's avatar
Richard Smith-Unna committed
10
# Overview
Jure's avatar
Jure committed
11

Richard Smith-Unna's avatar
Richard Smith-Unna committed
12
**PubSweet** allows you to build state-of-the-art publishing platforms.
Jure's avatar
Jure committed
13

Richard Smith-Unna's avatar
Richard Smith-Unna committed
14
It's a modular and flexible framework consisting of a **server** and **client** that work together, **components** that can modify or extend the functionality of the server and/or client, and a **command-line tool** that helps manage PubSweet apps.
Jure's avatar
Jure committed
15

Jure's avatar
Jure committed
16
# Documentation
Hem Brahmbhatt's avatar
Hem Brahmbhatt committed
17

Jure's avatar
Jure committed
18
The [PubSweet website](http://pubsweet.coko.foundation) contains all of the documentation for the PubSweet framework. Please submit an issue or MR if you find a piece of information is missing!
Jure's avatar
Jure committed
19

Richard Smith-Unna's avatar
Richard Smith-Unna committed
20
# Support
Jure's avatar
Jure committed
21

Jure's avatar
Jure committed
22
- **If you have a general query about PubSweet**, or want to discuss anything with us, come and [chat to us in our Mattermost channel](https://mattermost.coko.foundation/coko/channels/pubsweet).
Jure's avatar
Jure committed
23

Jure's avatar
Jure committed
24
- **Bug reports and feature requests** belong in the issues of this monorepo.
Richard Smith-Unna's avatar
Richard Smith-Unna committed
25

Richard Smith-Unna's avatar
Richard Smith-Unna committed
26
27
# Projects using PubSweet

Jure's avatar
Jure committed
28
29
- [Editoria](https://gitlab.coko.foundation/editoria/editoria) - a book production platform built for University of California Press
- [elife-xpub](https://github.com/elifesciences/elife-xpub/) - A journal publishing platform in collaboration with eLife
30
- [xpub-review](https://gitlab.com/hindawi/xpub/xpub-review) - A journal publishing platform in collaboration with Hindawi
Jure's avatar
Jure committed
31
- [Micropubs](https://gitlab.coko.foundation/micropubs/wormbase) - A micropublications platform in collaboration with Wormbase
Jure's avatar
Jure committed
32
- [Xpub](https://gitlab.coko.foundation/xpub/xpub) - Collabra, a journal publishing platform
Richard Smith-Unna's avatar
Richard Smith-Unna committed
33

Richard Smith-Unna's avatar
Richard Smith-Unna committed
34
35
36
37
# Credits

PubSweet is part of the [Collaborative Knowledge Foundation](https://coko.foundation) family.

Jure's avatar
Jure committed
38
<a href="https://coko.foundation"><img src="https://gitlab.coko.foundation/pubsweet/pubsweet/raw/master/assets/COKO_logo.png" width="300" /></a>