Skip to content

Commit

Permalink
Add a warning for the default branch rename (#380)
Browse files Browse the repository at this point in the history
* Add a warning for the default branch rename

* Add a link to Github's renaming documentation.
  • Loading branch information
salemhilal authored Feb 17, 2021
1 parent 707ab91 commit 2ebb422
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
[![Build Status](https://travis-ci.org/hound-search/hound.svg?branch=master)](https://travis-ci.org/hound-search/hound)
[![.github/workflows/go.yaml](https://github.com/hound-search/hound/workflows/.github/workflows/go.yaml/badge.svg)](https://github.com/hound-search/hound/actions)

> ## :warning: Hound's default branch name is changing! :warning:
> **We are renaming our default branch from `master` to `main` on February 24, 2021**. We will be using [Github's branch renaming feature](https://github.com/github/renaming/#renaming-existing-branches), which means that any open pull requests should be automatically re-targeted, and web requests pointing to code on the `master` branch should redirect as expected. This change should mostly be invisible, but you will need to update any code that explicitly relies on the existence of Hound's `master` branch.
Hound is an extremely fast source code search engine. The core is based on this article (and code) from Russ Cox:
[Regular Expression Matching with a Trigram Index](http://swtch.com/~rsc/regexp/regexp4.html). Hound itself is a static
[React](http://facebook.github.io/react/) frontend that talks to a [Go](http://golang.org/) backend. The backend keeps an up-to-date index for each repository and answers searches through a minimal API. Here it is in action:
Expand Down

0 comments on commit 2ebb422

Please sign in to comment.