Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
IvanJelicSF committed Jun 16, 2023
1 parent 620e36a commit ba701ff
Showing 1 changed file with 5 additions and 33 deletions.
38 changes: 5 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,26 @@

**Superdesk Publisher - the next generation publishing platform for journalists and newsrooms.**

*The Superdesk Publisher is an API-centric delivery tool for all digital platforms. Written from scratch in 2016, it utilizes the knowledge gained from 17 years of delivering digital news at scale with [Newscoop][2]. The Publisher is designed to work with any editorial system. Naturally, it works the best with our in-house newsroom management system, [Superdesk][3]. Therefore, it allows independent maintenance, upgrade and change of the editorial back-end system.*
*The Superdesk Publisher is an API-centric delivery tool for digital platforms. Written from scratch in 2016, it builds on top of the knowledge gained from 16 years of delivering digital news at scale with [Newscoop][2]. The Publisher is designed to extend our newsroom management system [Superdesk][3], providing complete, end to end digital publishing solution. Therefore, it allows independent development and maintenance of the editorial systems.*

## Documentation

Full documentation can be found here: [http://superdesk-publisher.readthedocs.org][1]

## Requirements

See [requirements](REQUIREMENTS.md) for general informations. And [composer.json](composer.json) for always up to date libraries and extensions requirements.
See [requirements](REQUIREMENTS.md) for general information, and [composer.json](composer.json) for always up to date libraries and extensions requirements.

## Installation

See [installation guide](INSTALL.md) for more details. We **strongly recommend** [using Docker](etc/docker/README.md) for local installation and testing.
We **strongly recommend** [using Docker](etc/docker/README.md) for local installation and testing.

There is an [installation guide](INSTALL.md) for setting up the required services and the Publisher manually.

[1]: http://superdesk-publisher.readthedocs.org/en/latest/
[2]: https://www.sourcefabric.org/en/newscoop/
[3]: https://www.superdesk.org/

## Testing

See [detailed instructions](testing.md) for more details.

## License

See the complete license [here](LICENSE.md).
Expand All @@ -33,29 +31,3 @@ See the complete license [here](LICENSE.md).
This project is a Sourcefabric z.ú. and contributors initiative.

List of all authors and contributors can be found [here](AUTHORS.md).

## Superdesk Publisher is possible thanks to other Sourcefabric initiatives:

Symfony Bundles:

| Name | CI Status |
| --- | --- |
| [swp/multi-tenancy-bundle](https://github.com/SuperdeskWebPublisher/SWPMultiTenancyBundle) | [![Build Status](https://travis-ci.org/SuperdeskWebPublisher/SWPMultiTenancyBundle.svg?branch=master)](https://travis-ci.org/SuperdeskWebPublisher/SWPMultiTenancyBundle) |
| [swp/rule-bundle](https://github.com/SuperdeskWebPublisher/SWPRuleBundle) | [![Build Status](https://travis-ci.org/SuperdeskWebPublisher/SWPRuleBundle.svg?branch=master)](https://travis-ci.org/SuperdeskWebPublisher/SWPRuleBundle) |
| [swp/storage-bundle](https://github.com/SuperdeskWebPublisher/SWPStorageBundle) | [![Build Status](https://travis-ci.org/SuperdeskWebPublisher/SWPStorageBundle.svg?branch=master)](https://travis-ci.org/SuperdeskWebPublisher/SWPStorageBundle) |
| [swp/bridge-bundle](https://github.com/SuperdeskWebPublisher/SWPBridgeBundle) | [![Build Status](https://travis-ci.org/SuperdeskWebPublisher/SWPBridgeBundle.svg?branch=master)](https://travis-ci.org/SuperdeskWebPublisher/SWPBridgeBundle) |
| [swp/templates-system-bundle](https://github.com/SuperdeskWebPublisher/SWPTemplatesBundle) | [![Build Status](https://travis-ci.org/SuperdeskWebPublisher/SWPTemplatesSystemBundle.svg?branch=master)](https://travis-ci.org/SuperdeskWebPublisher/SWPTemplatesSystemBundle) |
| [swp/settings-bundle](https://github.com/SuperdeskWebPublisher/SWPSettingsBundle) | [![Build Status](https://travis-ci.org/SuperdeskWebPublisher/SWPSettingsBundle.svg?branch=master)](https://travis-ci.org/SuperdeskWebPublisher/SWPSettingsBundle) |
| [swp/content-list-bundle](https://github.com/SuperdeskWebPublisher/SWPContentListBundle) | [![Build Status](https://travis-ci.org/SuperdeskWebPublisher/SWPContentListBundle.svg?branch=master)](https://travis-ci.org/SuperdeskWebPublisher/SWPContentListBundle) |
| [swp/menu-bundle](https://github.com/SuperdeskWebPublisher/SWPMenuBundle) | [![Build Status](https://travis-ci.org/SuperdeskWebPublisher/SWPMenuBundle.svg?branch=master)](https://travis-ci.org/SuperdeskWebPublisher/SWPMenuBundle) |

Components:

| Name | CI Status |
| --- | --- |
| [swp/templates-system](https://github.com/SuperdeskWebPublisher/templates-system) | [![Build Status](https://travis-ci.org/SuperdeskWebPublisher/templates-system.svg?branch=master)](https://travis-ci.org/SuperdeskWebPublisher/templates-system) |
| [swp/multi-tenancy](https://github.com/SuperdeskWebPublisher/multi-tenancy) | [![Build Status](https://travis-ci.org/SuperdeskWebPublisher/multi-tenancy.svg?branch=master)](https://travis-ci.org/SuperdeskWebPublisher/multi-tenancy) |
| [swp/rule](https://github.com/SuperdeskWebPublisher/rule) | [![Build Status](https://travis-ci.org/SuperdeskWebPublisher/rule.svg?branch=master)](https://travis-ci.org/SuperdeskWebPublisher/rule) |
| [swp/storage](https://github.com/SuperdeskWebPublisher/storage) | [![Build Status](https://travis-ci.org/SuperdeskWebPublisher/storage.svg?branch=master)](https://travis-ci.org/SuperdeskWebPublisher/storage) |
| [swp/bridge](https://github.com/SuperdeskWebPublisher/bridge) | [![Build Status](https://travis-ci.org/SuperdeskWebPublisher/bridge.svg?branch=master)](https://travis-ci.org/SuperdeskWebPublisher/bridge) |
| [swp/common](https://github.com/SuperdeskWebPublisher/common) | [![Build Status](https://travis-ci.org/SuperdeskWebPublisher/common.svg?branch=master)](https://travis-ci.org/SuperdeskWebPublisher/common) |

0 comments on commit ba701ff

Please sign in to comment.