Prepare public release

willdurand · willdurand · commit 5d196a906b4e · 2016-06-09T11:19:12.000+02:00
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,75 @@
+Code of Conduct
+===============
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hello@tailordev.fr. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,79 @@
+Contributing Guidelines
+=======================
+
+First of all, **thank you** for contributing, **you are awesome**!
+
+Before starting to contribute, you should read the following:
+
+* [How to contribute?](#how-to-contribute)
+* [Pull Request Guidelines](#pull-request-guidelines)
+* [Code of Conduct](CODE_OF_CONDUCT.md)
+
+---
+
+## How to contribute?
+
+### Report Bugs
+
+Report bugs at https://github.com/TailorDev/franklin/issues/new.
+
+When reporting a bug, please include:
+
+- Any details about your local setup that might be helpful in
+  troubleshooting;
+- Detailed steps to reproduce the bug. When possible, please
+  write a test case.
+
+### Fix Bugs
+
+Check out the [open bugs](https://github.com/TailorDev/franklin/issues) -
+anything tagged with the **[easy pick]** label could be a good choice
+for newcomers (and we are willing to help you).
+
+### Implement Features
+
+Look through the GitHub issues for features. Anything tagged with
+**[enhancement]** is open to whoever wants to implement it.
+
+### Submit Feedback
+
+Any issue with the **[question]** label is open for feedback, so feel
+free to share your thoughts with us!
+
+The best way to send feedback is to [fill a new
+issue](https://github.com/TailorDev/franklin/issues/new) on GitHub.
+
+If you are proposing a feature:
+
+- Explain how you envision it working. Try to be as detailed as you
+  can;
+- Try to keep the scope as narrow as possible. This will help make it
+  easier to implement;
+- Feel free to include any code you might already have, even if it's
+  just a rough idea. This is a volunteer-driven project, and
+  contributions are welcome :)
+
+
+## Pull Request Guidelines
+
+Here are a few rules to follow in order to ease code reviews, and discussions before
+maintainers accept and merge your work:
+
+- you MUST run the test suite;
+- you MUST write (or update) unit tests;
+- you SHOULD write documentation.
+
+Please, write [commit messages that make
+sense](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html),
+and [rebase your branch](http://git-scm.com/book/en/Git-Branching-Rebasing)
+before submitting your Pull Request.
+
+One may ask you to [squash your
+commits](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html)
+too. This is used to "clean" your Pull Request before merging it (we don't want
+commits such as `fix tests`, `fix 2`, `fix 3`, etc.).
+
+Also, while creating your Pull Request on GitHub, you MUST write a description
+which gives the context and/or explains why you are creating it.
+
+Thank you!
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) TailorDev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,4 +1,66 @@
 Franklin
 ========
 
-[![CircleCI](https://circleci.com/gh/TailorDev/franklin.svg?style=svg&circle-token=239258011bb36afbdc97d74ac5d842e1426acaa7)](https://circleci.com/gh/TailorDev/franklin)
+[![CircleCI](https://circleci.com/gh/TailorDev/franklin.svg?style=svg)](https://circleci.com/gh/TailorDev/franklin)
+
+Franklin is a DNA sequence annotation tool we built at TailorDev in order to
+play with SVGs and [React](https://facebook.github.io/react/) (again), as part
+of our "Le lab" sessions:
+
+* https://tailordev.fr/blog/2016/06/09/le-lab-3-franklin-dna-sequence-annotation-tool/
+
+![](doc/franklin-snapshot.jpg)
+
+
+## Installation
+
+### Production
+
+    $ git clone https://github.com/TailorDev/franklin.git
+    $ npm install # will run `npm run build`
+    $ npm prune --production
+
+We use this
+[Dockerfile](https://github.com/TailorDev/dockerfiles/blob/master/node/Dockerfile)
+to run franklin in production (which runs `npm run start` from franklin root
+directory).
+
+### Development
+
+    $ git clone https://github.com/TailorDev/franklin.git
+    $ npm install
+    $ npm run dev
+
+
+## Requirements
+
+We use `node` 5.8+ and `npm` 3.7+.
+
+
+## Contributing
+
+Please, see [CONTRIBUTING](CONTRIBUTING.md) file.
+
+## Running the Tests
+
+    $ npm run test
+
+You can also "watch" them:
+
+    $ npm run test:watch
+
+Code coverage is available by running:
+
+    $ npm run cov
+
+
+## Contributor Code of Conduct
+
+Please note that this project is released with a [Contributor Code of
+Conduct](http://contributor-covenant.org/). By participating in this project you
+agree to abide by its terms. See [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) file.
+
+## License
+
+Franklin is released under the MIT License. See the bundled
+[LICENSE](LICENSE.md) file for details.
diff --git a/app/scss/main.scss b/app/scss/main.scss
@@ -15,7 +15,7 @@
 $fa-font-path: '~font-awesome/fonts';
 @import '~font-awesome/scss/font-awesome.scss';
 
-/* -- Monod styles -- */
+/* -- Franklin styles -- */
 
 // Application
 @import 'mixins';
diff --git a/doc/franklin-snapshot.jpg b/doc/franklin-snapshot.jpg
diff --git a/package.json b/package.json
@@ -1,11 +1,10 @@
 {
   "name": "franklin",
   "version": "1.0.0",
-  "private": true,
   "repository": "https://github.com/TailorDev/franklin",
   "author": "TailorDev SAS",
   "license": "MIT",
-  "description": "",
+  "description": "TailorDev's DNA sequence tool",
   "main": "server.js",
   "scripts": {
     "build": "NODE_ENV=production webpack",
