Skip to content

Commit 382a6a3

Browse files
author
Lightning
committed
update readme
1 parent aa5b6b1 commit 382a6a3

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,30 @@
11
# go-privnote
22

3+
go-privnote is a Go client library for creating and reading notes on [Privnote](https://privnote.com/). It bypasses Cloudflare bot detection by using a [TLS client](https://github.com/bogdanfinn/tls-client) for TLS fingerprinting.
4+
35
[![Reference](http://img.shields.io/badge/go-documentation-blue.svg?style=flat-square)](https://pkg.go.dev/github.com/LightningDev1/go-privnote)
46
[![Linter](https://goreportcard.com/badge/github.com/LightningDev1/go-privnote?style=flat-square)](https://goreportcard.com/report/github.com/LightningDev1/go-privnote)
5-
[![Build status](https://github.com/LightningDev1/go-privnote/actions/workflows/ci.yml/badge.svg)](https://github.com/LightningDev1/go-privnote/actions)
7+
[![Build status](https://github.com/LightningDev1/go-privnote/actions/workflows/ci.yml/badge.svg)](https://github.com/LightningDev1/go-privnote/actions)
8+
9+
```go
10+
client := privnote.NewClient()
11+
12+
noteLink, err := client.CreateNote(privnote.CreateNoteData{
13+
Data: "Hello, World!",
14+
})
15+
16+
noteContent, err := client.ReadNoteFromLink("https://privnote.com/note-id#password")
17+
18+
noteContent, err := client.ReadNoteFromID("note-id", "password")
19+
```
20+
21+
## Installation
22+
23+
```bash
24+
go get github.com/LightningDev1/go-privnote
25+
```
26+
27+
## Usage
28+
29+
See [example/main.go](./example/main.go) for a complete example program.
30+

0 commit comments

Comments
 (0)