-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Lightning
committed
Jul 23, 2023
1 parent
aa5b6b1
commit 382a6a3
Showing
1 changed file
with
26 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,30 @@ | ||
# go-privnote | ||
|
||
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. | ||
|
||
[![Reference](http://img.shields.io/badge/go-documentation-blue.svg?style=flat-square)](https://pkg.go.dev/github.com/LightningDev1/go-privnote) | ||
[![Linter](https://goreportcard.com/badge/github.com/LightningDev1/go-privnote?style=flat-square)](https://goreportcard.com/report/github.com/LightningDev1/go-privnote) | ||
[![Build status](https://github.com/LightningDev1/go-privnote/actions/workflows/ci.yml/badge.svg)](https://github.com/LightningDev1/go-privnote/actions) | ||
[![Build status](https://github.com/LightningDev1/go-privnote/actions/workflows/ci.yml/badge.svg)](https://github.com/LightningDev1/go-privnote/actions) | ||
|
||
```go | ||
client := privnote.NewClient() | ||
|
||
noteLink, err := client.CreateNote(privnote.CreateNoteData{ | ||
Data: "Hello, World!", | ||
}) | ||
|
||
noteContent, err := client.ReadNoteFromLink("https://privnote.com/note-id#password") | ||
|
||
noteContent, err := client.ReadNoteFromID("note-id", "password") | ||
``` | ||
|
||
## Installation | ||
|
||
```bash | ||
go get github.com/LightningDev1/go-privnote | ||
``` | ||
|
||
## Usage | ||
|
||
See [example/main.go](./example/main.go) for a complete example program. | ||
|