SVI Formatting README with hints of linter markdown

README.md

@@ -1,21 +1,27 @@
+# goLevelDB
+
 This is an implementation of the [LevelDB key/value database](https://github.com/google/leveldb) in the [Go programming language](https://go.dev).
 
 [![Build Status](https://app.travis-ci.com/syndtr/goleveldb.svg?branch=master)](https://app.travis-ci.com/syndtr/goleveldb)
 
-Installation
------------
+## Other language
+
+[ru_RU.UTF-8](./docs/README_ru.md)
 
-	go get github.com/syndtr/goleveldb/leveldb
+## Installation
 
-Requirements
------------
+```bash
+go get github.com/syndtr/goleveldb/leveldb
+```
 
-* Need at least `go1.14` or newer.
+## Requirements
 
-Usage
------------
+Need at least `go1.14` or newer.
+
+## Usage
 
 Create or open a database:
+
 ```go
 // The returned DB instance is safe for concurrent use. Which mean that all
 // DB's methods may be called concurrently from multiple goroutine.
@@ -24,7 +30,9 @@ db, err := leveldb.OpenFile("path/to/db", nil)
 defer db.Close()
 ...
 ```
+
 Read or modify the database content:
+
 ```go
 // Remember that the contents of the returned slice should not be modified.
 data, err := db.Get([]byte("key"), nil)
@@ -36,53 +44,62 @@ err = db.Delete([]byte("key"), nil)
 ```
 
 Iterate over database content:
+
 ```go
 iter := db.NewIterator(nil, nil)
 for iter.Next() {
-	// Remember that the contents of the returned slice should not be modified, and
-	// only valid until the next call to Next.
-	key := iter.Key()
-	value := iter.Value()
-	...
+    // Remember that the contents of the returned slice should not be modified, and
+    // only valid until the next call to Next.
+    key := iter.Key()
+    value := iter.Value()
+    ...
 }
 iter.Release()
 err = iter.Error()
 ...
 ```
+
 Seek-then-Iterate:
+
 ```go
 iter := db.NewIterator(nil, nil)
 for ok := iter.Seek(key); ok; ok = iter.Next() {
-	// Use key/value.
-	...
+    // Use key/value.
+    ...
 }
 iter.Release()
 err = iter.Error()
 ...
 ```
+
 Iterate over subset of database content:
+
 ```go
 iter := db.NewIterator(&util.Range{Start: []byte("foo"), Limit: []byte("xoo")}, nil)
 for iter.Next() {
-	// Use key/value.
-	...
+    // Use key/value.
+    ...
 }
 iter.Release()
 err = iter.Error()
 ...
 ```
+
 Iterate over subset of database content with a particular prefix:
+
 ```go
 iter := db.NewIterator(util.BytesPrefix([]byte("foo-")), nil)
 for iter.Next() {
-	// Use key/value.
-	...
+    // Use key/value.
+    ..
 }
 iter.Release()
 err = iter.Error()
 ...
 ```
+
 Batch writes:
+
 ```go
 batch := new(leveldb.Batch)
 batch.Put([]byte("foo"), []byte("value"))
@@ -91,17 +108,19 @@ batch.Delete([]byte("baz"))
 err = db.Write(batch, nil)
 ...
 ```
+
 Use bloom filter:
+
 ```go
 o := &opt.Options{
-	Filter: filter.NewBloomFilter(10),
+    Filter: filter.NewBloomFilter(10),
 }
 db, err := leveldb.OpenFile("path/to/db", o)
 ...
 defer db.Close()
 ...
 ```
-Documentation
------------
+
+## Documentation
 
 You can read package documentation [here](https://pkg.go.dev/github.com/syndtr/goleveldb).

docs/README_ru.md

@@ -0,0 +1,123 @@
+# goLevelDB
+
+Этот проект является реализацией [LevelDB key/value database](https://github.com/google/leveldb) на языке программирования [Go](https://go.dev).
+
+[![Build Status](https://app.travis-ci.com/syndtr/goleveldb.svg?branch=master)](https://app.travis-ci.com/syndtr/goleveldb)
+
+## Установка
+
+```bash
+go get github.com/syndtr/goleveldb/leveldb
+```
+
+## Требования
+
+Необходим компилятор `go1.14` или новее.
+
+## Использование
+
+Cjplfybt yjdjq ,fps lfyys[]:
+
+```go
+// Возвращает новый экземпляр DB, безопасный для конкурентного использования. Which mean that all
+// DB's methods may be called concurrently from multiple goroutine.
+db, err := leveldb.OpenFile("path/to/db", nil)
+...
+defer db.Close()
+...
+```
+
+Чтение или изменение содержимого базы данных:
+
+```go
+// Remember that the contents of the returned slice should not be modified.
+data, err := db.Get([]byte("key"), nil)
+...
+err = db.Put([]byte("key"), []byte("value"), nil)
+...
+err = db.Delete([]byte("key"), nil)
+...
+```
+
+Итерация по содержимому базы данных:
+
+```go
+iter := db.NewIterator(nil, nil)
+for iter.Next() {
+    // Remember that the contents of the returned slice should not be modified, and
+    // only valid until the next call to Next.
+    key := iter.Key()
+    value := iter.Value()
+    ...
+}
+iter.Release()
+err = iter.Error()
+...
+```
+
+Поиск через итерацию:
+
+```go
+iter := db.NewIterator(nil, nil)
+for ok := iter.Seek(key); ok; ok = iter.Next() {
+    // Use key/value.
+    ...
+}
+iter.Release()
+err = iter.Error()
+...
+```
+
+Iterate over subset of database content:
+Итерация по подмножеству ключей по содержимому базы данных:
+
+```go
+iter := db.NewIterator(&util.Range{Start: []byte("foo"), Limit: []byte("xoo")}, nil)
+for iter.Next() {
+    // Use key/value.
+    ...
+}
+iter.Release()
+err = iter.Error()
+...
+```
+
+Итерация по подмножеству ключей с указанным префиксом:
+
+```go
+iter := db.NewIterator(util.BytesPrefix([]byte("foo-")), nil)
+for iter.Next() {
+    // Use key/value.
+    ..
+}
+iter.Release()
+err = iter.Error()
+...
+```
+
+Пакетная запись
+
+```go
+batch := new(leveldb.Batch)
+batch.Put([]byte("foo"), []byte("value"))
+batch.Put([]byte("bar"), []byte("another value"))
+batch.Delete([]byte("baz"))
+err = db.Write(batch, nil)
+...
+```
+
+С использованием фильтра Блума:
+
+```go
+o := &opt.Options{
+    Filter: filter.NewBloomFilter(10),
+}
+db, err := leveldb.OpenFile("path/to/db", o)
+...
+defer db.Close()
+...
+```
+
+## Документация
+
+Вы можете прочитать документацию [здесь](https://pkg.go.dev/github.com/syndtr/goleveldb).