Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(README): Change instructions for installing badger in README.md #1495

Merged
merged 5 commits into from
Sep 7, 2020
Merged

fix(README): Change instructions for installing badger in README.md #1495

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
57379d8
Fix Readme Installation instructions
vmrajas Sep 1, 2020
5e2b3a7
Fix linking
vmrajas Sep 1, 2020
7789437
Address comments
vmrajas Sep 1, 2020
e98e9f8
Move README.md content to Badger docs
vmrajas Sep 7, 2020
91367f8
Suggested changes
vmrajas Sep 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ For more details on our version naming schema please read [Choosing a version](#

## Table of Contents
* [Getting Started](#getting-started)
+ [Installing](#installing)
+ [Installing](#installing-latest-release)
- [Choosing a version](#choosing-a-version)
+ [Opening a database](#opening-a-database)
+ [Transactions](#transactions)
Expand Down Expand Up @@ -66,11 +66,14 @@ For more details on our version naming schema please read [Choosing a version](#

## Getting Started

### Installing
### Installing Latest release
To start using Badger, install Go 1.12 or above and run `go get`:

```sh
$ go get github.com/dgraph-io/badger/v2
$ cd $GOPATH/src/github.com/dgraph-io/badger
$ git checkout v2.2007.1
$ cd badger && go install
```

This will retrieve the library and install the `badger` command line
Expand Down Expand Up @@ -908,7 +911,7 @@ Assume you were on badger v1.6.0 and you wish to migrate to v2.0.0 version.
- `cd badger && go install`

This should install new badger binary in your $GOBIN
4. Install badger version v2.0.0
4. Restore data from backup
- `badger restore --dir path/to/new/badger/directory -f badger.backup`

This will create a new directory on `path/to/new/badger/directory` and add badger data in
Expand Down
2 changes: 1 addition & 1 deletion docs/content/faq/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ Assume you were on badger v1.6.0 and you wish to migrate to v2.0.0 version.
- `cd badger && go install`

This should install new badger binary in your $GOBIN
4. Install badger version v2.0.0
4. Restore data from backup
- `badger restore --dir path/to/new/badger/directory -f badger.backup`

This will create a new directory on `path/to/new/badger/directory` and add badger data in
Expand Down
5 changes: 4 additions & 1 deletion docs/content/get-started/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,14 @@ aliases = ["/get-started"]
+++


## Installing
## Installing Latest release
To start using Badger, install Go 1.12 or above and run `go get`:

```
$ go get github.com/dgraph-io/badger/v2
$ cd $GOPATH/src/github.com/dgraph-io/badger
$ git checkout v2.2007.1
$ cd badger && go install
```

This will retrieve the library and install the `badger` command line
Expand Down