Skip to content

Commit

Permalink
Add a short README that covers the monorepo
Browse files Browse the repository at this point in the history
The language is roughly taken from the client README.
  • Loading branch information
legoktm committed Dec 11, 2023
1 parent d313d0d commit 79035f0
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 16 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
> [There are many ways to contribute, and we welcome your help!](CONTRIBUTING.md) By contributing to this project, you agree to abide by our [Code of Conduct](https://github.com/freedomofpress/.github/blob/main/CODE_OF_CONDUCT.md).
[![CircleCI](https://circleci.com/gh/freedomofpress/securedrop-client.svg?style=svg)](https://circleci.com/gh/freedomofpress/securedrop-client)
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/freedomofpress/securedrop)

# securedrop-client

The SecureDrop Client is a desktop application for journalists to communicate with sources and work with submissions on the
[SecureDrop Workstation](https://github.com/freedomofpress/securedrop-workstation). It runs within a [Qubes OS](https://www.qubes-os.org/intro/)
virtual machine that has no direct network access and opens files within individual, non-networked, disposable VMs.

This repository contains multiple components, including:
* `client`: desktop GUI application
* `export`: logic for exporting submissions
* `log`: centralized logging
* `proxy`: restricted HTTP proxy

Each component's folder has a README with more detail.

To learn more about architecture and our rationale behind our Qubes OS approach, see the
[SecureDrop Workstation readme](https://github.com/freedomofpress/securedrop-workstation/blob/main/README.md).

**IMPORTANT:** This project is currently undergoing a pilot study and should not be used in production environments.
5 changes: 0 additions & 5 deletions client/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
> [There are many ways to contribute, and we welcome your help!](CONTRIBUTING.md) By contributing to this project, you agree to abide by our [Code of Conduct](https://github.com/freedomofpress/.github/blob/main/CODE_OF_CONDUCT.md).
[![CircleCI](https://circleci.com/gh/freedomofpress/securedrop-client.svg?style=svg)](https://circleci.com/gh/freedomofpress/securedrop-client)
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/freedomofpress/securedrop?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

# securedrop-client

The SecureDrop Client is a desktop application for journalists to communicate with sources and work with submissions on the [SecureDrop Workstation](https://github.com/freedomofpress/securedrop-workstation).
Expand Down
4 changes: 0 additions & 4 deletions export/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
> By contributing to this project, you agree to abide by our [Code of Conduct](https://github.com/freedomofpress/.github/blob/main/CODE_OF_CONDUCT.md).
[![CircleCI](https://circleci.com/gh/freedomofpress/securedrop-export.svg?style=svg)](https://circleci.com/gh/freedomofpress/securedrop-export)

# securedrop-export

Code for exporting and printing files from the SecureDrop Qubes Workstation.
Expand Down
2 changes: 0 additions & 2 deletions log/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
> By contributing to this project, you agree to abide by our [Code of Conduct](https://github.com/freedomofpress/.github/blob/main/CODE_OF_CONDUCT.md).
# securedrop-log

`securedrop-log` is part of the [SecureDrop
Expand Down
5 changes: 0 additions & 5 deletions proxy/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
> By contributing to this project, you agree to abide by our [Code of Conduct](https://github.com/freedomofpress/.github/blob/main/CODE_OF_CONDUCT.md).
## securedrop workstation proxy

[![CircleCI](https://circleci.com/gh/freedomofpress/securedrop-proxy.svg?style=svg)](https://circleci.com/gh/freedomofpress/securedrop-proxy)

`securedrop-proxy` is part of the [SecureDrop
Workstation](https://github.com/freedomofpress/securedrop-workstation) project.

Expand Down

0 comments on commit 79035f0

Please sign in to comment.