Skip to content

Commit

Permalink
[docs] Move contributors section to docs (#120)
Browse files Browse the repository at this point in the history
  • Loading branch information
pranavrajs authored Oct 6, 2019
1 parent bbbc144 commit 902b8e8
Show file tree
Hide file tree
Showing 6 changed files with 196 additions and 31 deletions.
4 changes: 2 additions & 2 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"files": [
"README.md"
"docs/contributors.md"
],
"imageSize": 100,
"imageSize": 48,
"commit": false,
"contributors": [
{
Expand Down
28 changes: 4 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
<p align="center">
<img src=".github/woot-logo.svg" alt="Woo-logo" width="240">

<div align="center">Opensource alternative to Intercom, Zendesk, Drift, Crisp etc.</div>
<img src=".github/woot-logo.svg" alt="Woo-logo" width="240">
<div align="center">Opensource alternative to Intercom, Zendesk, Drift, Crisp etc.</div>
</p>

___

![CircleCI Badge](https://img.shields.io/circleci/build/github/chatwoot/chatwoot)
Expand All @@ -12,12 +10,10 @@ ___
![License](https://img.shields.io/github/license/chatwoot/chatwoot)
[![Maintainability](https://api.codeclimate.com/v1/badges/80f9e1a7c72d186289ad/maintainability)](https://codeclimate.com/github/chatwoot/chatwoot/maintainability)
![Commits-per-month](https://img.shields.io/github/commit-activity/m/chatwoot/chatwoot)

![ChatUI progess](https://chatwoot.com/images/dashboard-screen.png)

## Quick Setup


### Install JS dependencies

``` bash
Expand Down Expand Up @@ -61,28 +57,12 @@ password: 123456

### Detailed documentation

Detailed documentation is available at [docs.chatwoot.com](https://docs.chatwoot.com)
Detailed documentation is available at [docs.chatwoot.com](https://docs.chatwoot.com)

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
<table>
<tr>
<td align="center"><a href="http://nithindavid.me"><img src="https://avatars2.githubusercontent.com/u/1277421?v=4" width="100px;" alt="Nithin David Thomas"/><br /><sub><b>Nithin David Thomas</b></sub></a><br /><a href="https://github.com/chatwoot/chatwoot/issues?q=author%3Anithindavid" title="Bug reports">🐛</a> <a href="#blog-nithindavid" title="Blogposts">📝</a> <a href="https://github.com/chatwoot/chatwoot/commits?author=nithindavid" title="Code">💻</a> <a href="https://github.com/chatwoot/chatwoot/commits?author=nithindavid" title="Documentation">📖</a> <a href="#design-nithindavid" title="Design">🎨</a> <a href="#maintenance-nithindavid" title="Maintenance">🚧</a> <a href="#review-nithindavid" title="Reviewed Pull Requests">👀</a></td>
<td align="center"><a href="https://github.com/pranavrajs"><img src="https://avatars3.githubusercontent.com/u/2246121?v=4" width="100px;" alt="Pranav Raj S"/><br /><sub><b>Pranav Raj S</b></sub></a><br /><a href="https://github.com/chatwoot/chatwoot/issues?q=author%3Apranavrajs" title="Bug reports">🐛</a> <a href="#blog-pranavrajs" title="Blogposts">📝</a> <a href="https://github.com/chatwoot/chatwoot/commits?author=pranavrajs" title="Code">💻</a> <a href="https://github.com/chatwoot/chatwoot/commits?author=pranavrajs" title="Documentation">📖</a> <a href="#design-pranavrajs" title="Design">🎨</a> <a href="#maintenance-pranavrajs" title="Maintenance">🚧</a> <a href="#review-pranavrajs" title="Reviewed Pull Requests">👀</a></td>
<td align="center"><a href="http://www.linkedin.com/in/subintp"><img src="https://avatars1.githubusercontent.com/u/1742357?v=4" width="100px;" alt="Subin T P"/><br /><sub><b>Subin T P</b></sub></a><br /><a href="https://github.com/chatwoot/chatwoot/issues?q=author%3Asubintp" title="Bug reports">🐛</a> <a href="https://github.com/chatwoot/chatwoot/commits?author=subintp" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/manojmj92"><img src="https://avatars1.githubusercontent.com/u/4034241?v=4" width="100px;" alt="Manoj M J"/><br /><sub><b>Manoj M J</b></sub></a><br /><a href="https://github.com/chatwoot/chatwoot/issues?q=author%3Amanojmj92" title="Bug reports">🐛</a> <a href="https://github.com/chatwoot/chatwoot/commits?author=manojmj92" title="Code">💻</a> <a href="#review-manojmj92" title="Reviewed Pull Requests">👀</a></td>
<td align="center"><a href="http://sojan.me"><img src="https://avatars1.githubusercontent.com/u/73185?v=4" width="100px;" alt="Sojan Jose"/><br /><sub><b>Sojan Jose</b></sub></a><br /><a href="https://github.com/chatwoot/chatwoot/issues?q=author%3Asojan-official" title="Bug reports">🐛</a> <a href="#blog-sojan-official" title="Blogposts">📝</a> <a href="https://github.com/chatwoot/chatwoot/commits?author=sojan-official" title="Code">💻</a> <a href="https://github.com/chatwoot/chatwoot/commits?author=sojan-official" title="Documentation">📖</a> <a href="#design-sojan-official" title="Design">🎨</a> <a href="#maintenance-sojan-official" title="Maintenance">🚧</a> <a href="#review-sojan-official" title="Reviewed Pull Requests">👀</a></td>
</tr>
</table>

<!-- ALL-CONTRIBUTORS-LIST:END -->
Thanks goes to all these [wonderful people](https://github.com/chatwoot/chatwoot/blob/master/docs/contributors.md):

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!



*Chatwoot* &copy; 2017-2019, ThoughtWoot Inc - Released under the MIT License.
2 changes: 2 additions & 0 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@
* [Project Dependencies](development/project-setup/dependencies.md)
* [Environment Variables](development/project-setup/environment-variables.md)
* [Common Errors](development/project-setup/errors.md)
* [Contributing Guide](contributing.md)
* [Contributors](contributors.md)
15 changes: 15 additions & 0 deletions docs/contributors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
### Contributors

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
<table>
<tr>
<td align="center"><a href="http://nithindavid.me"><img src="https://avatars2.githubusercontent.com/u/1277421?v=4" width="48px;" alt="Nithin David Thomas"/><br /><sub><b>Nithin David Thomas</b></sub></a><br /><a href="https://github.com/chatwoot/chatwoot/issues?q=author%3Anithindavid" title="Bug reports">🐛</a> <a href="#blog-nithindavid" title="Blogposts">📝</a> <a href="https://github.com/chatwoot/chatwoot/commits?author=nithindavid" title="Code">💻</a> <a href="https://github.com/chatwoot/chatwoot/commits?author=nithindavid" title="Documentation">📖</a> <a href="#design-nithindavid" title="Design">🎨</a> <a href="#maintenance-nithindavid" title="Maintenance">🚧</a> <a href="#review-nithindavid" title="Reviewed Pull Requests">👀</a></td>
<td align="center"><a href="https://github.com/pranavrajs"><img src="https://avatars3.githubusercontent.com/u/2246121?v=4" width="48px;" alt="Pranav Raj S"/><br /><sub><b>Pranav Raj S</b></sub></a><br /><a href="https://github.com/chatwoot/chatwoot/issues?q=author%3Apranavrajs" title="Bug reports">🐛</a> <a href="#blog-pranavrajs" title="Blogposts">📝</a> <a href="https://github.com/chatwoot/chatwoot/commits?author=pranavrajs" title="Code">💻</a> <a href="https://github.com/chatwoot/chatwoot/commits?author=pranavrajs" title="Documentation">📖</a> <a href="#design-pranavrajs" title="Design">🎨</a> <a href="#maintenance-pranavrajs" title="Maintenance">🚧</a> <a href="#review-pranavrajs" title="Reviewed Pull Requests">👀</a></td>
<td align="center"><a href="http://www.linkedin.com/in/subintp"><img src="https://avatars1.githubusercontent.com/u/1742357?v=4" width="48px;" alt="Subin T P"/><br /><sub><b>Subin T P</b></sub></a><br /><a href="https://github.com/chatwoot/chatwoot/issues?q=author%3Asubintp" title="Bug reports">🐛</a> <a href="https://github.com/chatwoot/chatwoot/commits?author=subintp" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/manojmj92"><img src="https://avatars1.githubusercontent.com/u/4034241?v=4" width="48px;" alt="Manoj M J"/><br /><sub><b>Manoj M J</b></sub></a><br /><a href="https://github.com/chatwoot/chatwoot/issues?q=author%3Amanojmj92" title="Bug reports">🐛</a> <a href="https://github.com/chatwoot/chatwoot/commits?author=manojmj92" title="Code">💻</a> <a href="#review-manojmj92" title="Reviewed Pull Requests">👀</a></td>
<td align="center"><a href="http://sojan.me"><img src="https://avatars1.githubusercontent.com/u/73185?v=4" width="48px;" alt="Sojan Jose"/><br /><sub><b>Sojan Jose</b></sub></a><br /><a href="https://github.com/chatwoot/chatwoot/issues?q=author%3Asojan-official" title="Bug reports">🐛</a> <a href="#blog-sojan-official" title="Blogposts">📝</a> <a href="https://github.com/chatwoot/chatwoot/commits?author=sojan-official" title="Code">💻</a> <a href="https://github.com/chatwoot/chatwoot/commits?author=sojan-official" title="Documentation">📖</a> <a href="#design-sojan-official" title="Design">🎨</a> <a href="#maintenance-sojan-official" title="Maintenance">🚧</a> <a href="#review-sojan-official" title="Reviewed Pull Requests">👀</a></td>
</tr>
</table>

<!-- ALL-CONTRIBUTORS-LIST:END -->
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@
]
},
"scripts": {
"docs": "docsify serve docs",
"eslint": "eslint app/javascript --fix"
}
}
Loading

0 comments on commit 902b8e8

Please sign in to comment.