Skip to content

Commit 372df52

Browse files
jwierzboSimran-B
andauthored
Doc update (#623)
* OASIS-25945 Deprecate VPACK * Update CHANGELOG.md * Update README.md * Integrate v1 tutorial for long-term preservation Will be removed from Developer Hub and ArangoDB University * Rework v2 readme --------- Co-authored-by: Simran Spiller <simran@arangodb.com>
1 parent 2e52b69 commit 372df52

File tree

3 files changed

+730
-24
lines changed

3 files changed

+730
-24
lines changed

README.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,34 @@
1-
![ArangoDB-Logo](https://user-images.githubusercontent.com/3998723/207981337-79d49127-48fc-4c7c-9411-8a688edca1dd.png)
1+
# ArangoDB Go Driver
22

3-
4-
# ArangoDB GO Driver
5-
6-
This project contains the official Go driver for the [ArangoDB database](https://arangodb.com).
3+
This project contains the official Go driver for the [ArangoDB database system](https://arangodb.com).
74

85
[![CircleCI](https://dl.circleci.com/status-badge/img/gh/arangodb/go-driver/tree/master.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/arangodb/go-driver/tree/master)
96
[![GoDoc](https://godoc.org/github.com/arangodb/go-driver?status.svg)](http://godoc.org/github.com/arangodb/go-driver)
107

11-
> **Warning**
12-
> V1 is deprecated and will not receive any new features. Please use [V2](v2) instead.
8+
Version 2:
9+
- Tutorial coming soon
10+
- [Code examples](v2/examples/)
11+
- [Reference documentation](https://godoc.org/github.com/arangodb/go-driver/v2)
1312

14-
- [Getting Started](https://docs.arangodb.com/stable/develop/drivers/go/)
15-
- [Example Requests](v2/examples)
16-
- [Reference](https://godoc.org/github.com/arangodb/go-driver)
13+
Version 1:
14+
- ⚠️ This version is deprecated and will not receive any new features.
15+
Please use version 2 ([v2](v2/)) instead.
16+
- [Tutorial](Tutorial_v1.md)
17+
- [Code examples](examples/)
18+
- [Reference documentation](https://godoc.org/github.com/arangodb/go-driver)
1719

18-
# Supported Go Versions
20+
## Supported Go Versions
1921

20-
| | Go 1.19 | Go 1.20 | Go 1.21 |
22+
| Driver | Go 1.19 | Go 1.20 | Go 1.21 |
2123
|---------------|---------|---------|---------|
2224
| `1.5.0-1.6.1` || - | - |
2325
| `1.6.2` ||||
2426
| `2.1.0` ||||
2527
| `master` ||||
2628

27-
# Supported Versions
29+
## Supported ArangoDB Versions
2830

29-
| | ArangoDB 3.10 | ArangoDB 3.11 | ArangoDB 3.12 |
31+
| Driver | ArangoDB 3.10 | ArangoDB 3.11 | ArangoDB 3.12 |
3032
|----------|---------------|---------------|---------------|
3133
| `1.5.0` || - | - |
3234
| `1.6.0` ||| - |
@@ -35,6 +37,7 @@ This project contains the official Go driver for the [ArangoDB database](https:/
3537

3638
Key:
3739

38-
* `` Exactly the same features in both driver and the ArangoDB version.
39-
* `+` Features included in driver may be not present in the ArangoDB API. Calls to the ArangoDB may result in unexpected responses (404).
40-
* `-` The ArangoDB has features which are not supported by driver.
40+
* `` Exactly the same features in both the driver and the ArangoDB version.
41+
* `+` Features included in the driver may be not present in the ArangoDB API.
42+
Calls to ArangoDB may result in unexpected responses (404).
43+
* `-` The ArangoDB version has features that are not supported by the driver.

0 commit comments

Comments
 (0)