Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/README.md

84 lines
4.9 KiB
Markdown
Raw Normal View History

Add anchor tags to README.md.
2016-05-15 19:50:55 +02:00
# Zulip overview
Add description of Zulip at top of README.md. Based on PR #22 by GedLawrenson.
2015-09-27 03:07:06 +02:00
docs: Update README.md description.
2022-01-07 00:21:27 +01:00
[Zulip](https://zulip.com) is an open-source team collaboration tool with unique
[topic-based threading][why-zulip] that combines the best of email and chat to
make remote work productive and delightful. Fortune 500 companies, [leading open
source projects][rust-case-study], and thousands of other organizations use
Zulip every day. Zulip is the only [modern team chat app][features] that is
designed for both live and asynchronous conversations.
Zulip is built by a distributed community of developers from all around the
world, with 74+ people who have each contributed 100+ commits. With
portico: Update contributor count from 700 to 1000. Note: I did not check whether we have numbers other than 700 that also need to be updated.
2022-01-24 19:39:34 +01:00
over 1000 contributors merging over 500 commits a month, Zulip is the
docs: Update README.md description.
2022-01-07 00:21:27 +01:00
largest and fastest growing open source team chat project.
Expand documentation on contributing to Zulip.
2015-10-17 20:16:13 +02:00
docs: Update README and installation guide. This is a general cleanup that also aims to link to the new self-hosting page to provide added context.
2022-02-12 01:32:47 +01:00
Come find us on the [development community chat](https://zulip.com/development-community/)!
Rename default branch to ‘main’. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-09-01 00:15:31 +02:00
[![GitHub Actions build status](https://github.com/zulip/zulip/actions/workflows/zulip-ci.yml/badge.svg)](https://github.com/zulip/zulip/actions/workflows/zulip-ci.yml?query=branch%3Amain)
[![coverage status](https://img.shields.io/codecov/c/github/zulip/zulip/main.svg)](https://codecov.io/gh/zulip/zulip)
lint: Fix long lines in README.md.
2017-11-16 20:38:13 +01:00
[![Mypy coverage](https://img.shields.io/badge/mypy-100%25-green.svg)][mypy-coverage]
docs: Update Ruff badge and links. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2023-10-27 00:19:05 +02:00
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
docs: Document Black and isort. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-13 00:21:10 +01:00
[![code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
docs: Document that we use Prettier. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-07-22 21:25:49 +02:00
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
README: Add latest GitHub release badge to README.
2018-11-16 05:07:15 +01:00
[![GitHub release](https://img.shields.io/github/release/zulip/zulip.svg)](https://github.com/zulip/zulip/releases/latest)
docs: Update links to ReadTheDocs to always use https. This is better security practice. We also add a lint rule to enforce this for the future.
2017-11-16 19:54:24 +01:00
[![docs](https://readthedocs.org/projects/zulip/badge/?version=latest)](https://zulip.readthedocs.io/en/latest/)
README: Wrap GitHub badges to be one line for each badges. Apparently, we no longer need to do the hacky no-line-wrapping thing we were doing for these to work.
2017-09-29 07:39:04 +02:00
[![Zulip chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://chat.zulip.org)
lint: Fix long lines in README.md.
2017-11-16 20:38:13 +01:00
[![Twitter](https://img.shields.io/badge/twitter-@zulip-blue.svg?style=flat)](https://twitter.com/zulip)
readme: Add GitHub sponsors badge in README. The number is really low, since we haven't told anyone about our GitHub Sponsors site, so the badge probably isn't actually helpful, but I suppose that's OK.
2021-03-08 12:40:01 +01:00
[![GitHub Sponsors](https://img.shields.io/github/sponsors/zulip)](https://github.com/sponsors/zulip)
lint: Fix long lines in README.md.
2017-11-16 20:38:13 +01:00
[mypy-coverage]: https://blog.zulip.org/2016/10/13/static-types-in-python-oh-mypy/
docs: Update README.md description.
2022-01-07 00:21:27 +01:00
[why-zulip]: https://zulip.com/why-zulip/
[rust-case-study]: https://zulip.com/case-studies/rust/
[features]: https://zulip.com/features/
Add Travis CI button to README.md
2016-02-21 01:47:04 +01:00
docs: Make minor updates to CONTRIBUTING.md and README.md.
2017-11-15 06:30:41 +01:00
## Getting started
docs: Split a CONTRIBUTING.md out of README.md. Also contains a number of updates, additions, and deletions; this is essentially a rewrite of the github landing page experience.
2017-11-13 23:12:16 +01:00
docs: Update README and installation guide. This is a general cleanup that also aims to link to the new self-hosting page to provide added context.
2022-02-12 01:32:47 +01:00
- **Contributing code**. Check out our [guide for new
docs: Update global links to new contributing guide URL. Logically, these are part of the previous commit, but won't pass CI until ReadTheDocs has built the previous commit and generated the target page.
2022-08-25 20:24:50 +02:00
contributors](https://zulip.readthedocs.io/en/latest/contributing/contributing.html)
README: Tweak grammar and minor language details. With some additional edits by tabbott.
2022-09-01 09:50:22 +02:00
to get started. We have invested in making Zulip’s code highly
readable, thoughtfully tested, and easy to modify. Beyond that, we
have written an extraordinary 150K words of documentation for Zulip
contributors.
docs: Update README and installation guide. This is a general cleanup that also aims to link to the new self-hosting page to provide added context.
2022-02-12 01:32:47 +01:00
- **Contributing non-code**. [Report an
docs: Update global links to new contributing guide URL. Logically, these are part of the previous commit, but won't pass CI until ReadTheDocs has built the previous commit and generated the target page.
2022-08-25 20:24:50 +02:00
issue](https://zulip.readthedocs.io/en/latest/contributing/contributing.html#reporting-issues),
docs: Update README and installation guide. This is a general cleanup that also aims to link to the new self-hosting page to provide added context.
2022-02-12 01:32:47 +01:00
[translate](https://zulip.readthedocs.io/en/latest/translating/translating.html)
Zulip into your language, or [give us
docs: Update global links to new contributing guide URL. Logically, these are part of the previous commit, but won't pass CI until ReadTheDocs has built the previous commit and generated the target page.
2022-08-25 20:24:50 +02:00
feedback](https://zulip.readthedocs.io/en/latest/contributing/contributing.html#user-feedback).
docs: Update README and installation guide. This is a general cleanup that also aims to link to the new self-hosting page to provide added context.
2022-02-12 01:32:47 +01:00
We'd love to hear from you, whether you've been using Zulip for years, or are just
trying it out for the first time.
- **Checking Zulip out**. The best way to see Zulip in action is to drop by the
[Zulip community server](https://zulip.com/development-community/). We also
recommend reading about Zulip's [unique
approach](https://zulip.com/why-zulip/) to organizing conversations.
README: Tweak grammar and minor language details. With some additional edits by tabbott.
2022-09-01 09:50:22 +02:00
- **Running a Zulip server**. Self-host Zulip directly on Ubuntu or Debian
docs: Update README and installation guide. This is a general cleanup that also aims to link to the new self-hosting page to provide added context.
2022-02-12 01:32:47 +01:00
Linux, in [Docker](https://github.com/zulip/docker-zulip), or with prebuilt
images for [Digital Ocean](https://marketplace.digitalocean.com/apps/zulip) and
[Render](https://render.com/docs/deploy-zulip).
Learn more about [self-hosting Zulip](https://zulip.com/self-hosting/).
- **Using Zulip without setting up a server**. Learn about [Zulip
Cloud](https://zulip.com/plans/) hosting options. Zulip sponsors free [Zulip
Cloud Standard](https://zulip.com/plans/) for hundreds of worthy
organizations, including [fellow open-source
projects](https://zulip.com/for/open-source/).
docs: Split a CONTRIBUTING.md out of README.md. Also contains a number of updates, additions, and deletions; this is essentially a rewrite of the github landing page experience.
2017-11-13 23:12:16 +01:00
docs: Apply bullet style changes from Prettier. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-08-20 21:45:39 +02:00
- **Participating in [outreach
docs: Update global links to new contributing guide URL. Logically, these are part of the previous commit, but won't pass CI until ReadTheDocs has built the previous commit and generated the target page.
2022-08-25 20:24:50 +02:00
programs](https://zulip.readthedocs.io/en/latest/contributing/contributing.html#outreach-programs)**
docs: Update README and installation guide. This is a general cleanup that also aims to link to the new self-hosting page to provide added context.
2022-02-12 01:32:47 +01:00
like [Google Summer of Code](https://developers.google.com/open-source/gsoc/)
and [Outreachy](https://www.outreachy.org/).
- **Supporting Zulip**. Advocate for your organization to use Zulip, become a
[sponsor](https://github.com/sponsors/zulip), write a review in the mobile app
stores, or [help others find
docs: Update global links to new contributing guide URL. Logically, these are part of the previous commit, but won't pass CI until ReadTheDocs has built the previous commit and generated the target page.
2022-08-25 20:24:50 +02:00
Zulip](https://zulip.readthedocs.io/en/latest/contributing/contributing.html#help-others-find-zulip).
docs: Update README and installation guide. This is a general cleanup that also aims to link to the new self-hosting page to provide added context.
2022-02-12 01:32:47 +01:00
You may also be interested in reading our [blog](https://blog.zulip.org/), and
following us on [Twitter](https://twitter.com/zulip) and
[LinkedIn](https://www.linkedin.com/company/zulip-project/).
docs: Split a CONTRIBUTING.md out of README.md. Also contains a number of updates, additions, and deletions; this is essentially a rewrite of the github landing page experience.
2017-11-13 23:12:16 +01:00
docs: Move license declaration from README.md to LICENSE.
2017-11-14 21:21:05 +01:00
Zulip is distributed under the
Rename default branch to ‘main’. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-09-01 00:15:31 +02:00
[Apache 2.0](https://github.com/zulip/zulip/blob/main/LICENSE) license.