natty
/
fox-send
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #528 from tiagmoraismorgado/patch-2 

adding separators to README
This commit is contained in:
Danny Coates 2017-08-24 15:48:35 -07:00 committed by GitHub
parent 8f1c404724 1b975e7ba7
commit c592f84d7d
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -5,10 +5,14 @@
**Docs:** [Docker](docs/docker.md), [Metrics](docs/metrics.md) **Docs:** [Docker](docs/docker.md), [Metrics](docs/metrics.md)
---
## What it does ## What it does
A file sharing experiment which allows you to send encrypted files to other users. A file sharing experiment which allows you to send encrypted files to other users.
---
## Requirements ## Requirements
- [Node.js 8+](https://nodejs.org/) - [Node.js 8+](https://nodejs.org/)
@ -20,6 +24,8 @@ A file sharing experiment which allows you to send encrypted files to other user
$ redis-server /usr/local/etc/redis.conf $ redis-server /usr/local/etc/redis.conf
``` ```
---
## How to use it ## How to use it
| Command | Description | | Command | Description |
@ -30,14 +36,20 @@ $ redis-server /usr/local/etc/redis.conf
| `npm start` | Starts the Express web server. | `npm start` | Starts the Express web server.
| `npm test` | Runs the suite of mocha tests. | `npm test` | Runs the suite of mocha tests.
---
## Localization ## Localization
Firefox Send localization is managed via [Pontoon](https://pontoon.mozilla.org/projects/test-pilot-firefox-send/), not direct pull requests to the repository. If you want to fix a typo, add a new language, or simply know more about localization, please get in touch with the [existing localization team](https://pontoon.mozilla.org/teams/) for your language, or Mozilla’s [l10n-drivers](https://wiki.mozilla.org/L10n:Mozilla_Team#Mozilla_Corporation) for guidance. Firefox Send localization is managed via [Pontoon](https://pontoon.mozilla.org/projects/test-pilot-firefox-send/), not direct pull requests to the repository. If you want to fix a typo, add a new language, or simply know more about localization, please get in touch with the [existing localization team](https://pontoon.mozilla.org/teams/) for your language, or Mozilla’s [l10n-drivers](https://wiki.mozilla.org/L10n:Mozilla_Team#Mozilla_Corporation) for guidance.
---
## Contributing ## Contributing
Pull requests are always welcome! Feel free to check out the list of ["good first bugs"](https://github.com/mozilla/send/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+bug%22). Pull requests are always welcome! Feel free to check out the list of ["good first bugs"](https://github.com/mozilla/send/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+bug%22).
---
## Testing ## Testing
| ENVIRONMENT | URL | ENVIRONMENT | URL
@ -46,6 +58,10 @@ Pull requests are always welcome! Feel free to check out the list of ["good firs
| Stage | <https://send.stage.mozaws.net/> | Stage | <https://send.stage.mozaws.net/>
| Development | <https://send.dev.mozaws.net/> | Development | <https://send.dev.mozaws.net/>
---
## License ## License
[Mozilla Public License Version 2.0](LICENSE) [Mozilla Public License Version 2.0](LICENSE)
---