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 snippet examples #143

Merged
merged 1 commit into from
Sep 19, 2022
Merged

fix snippet examples #143

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 12 additions & 8 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ Purpose: dump Slack messages, users and files using browser token and cookie.
Typical use scenarios:

* archive your private conversations from Slack when the administrator
does not allow you to install applications OR you don't want to use
potentially privacy-violating third-party tools,
does not allow you to install applications OR you don't want to use
potentially privacy-violating third-party tools,
* archive channels from Slack when you're on a free "no archive" subscription,
so you don't lose valuable knowledge in those channels.
* create a Slack Export archive without admin access.
Expand All @@ -34,7 +34,7 @@ There a three modes of operation (more on this in `User Guide`_) :

Slackdump accepts two types of input (see `Dumping Conversations`_ section):

#. the URL/link of the channel or thread, OR
#. the URL/link of the channel or thread, OR
#. the ID of the channel.


Expand All @@ -57,7 +57,7 @@ mode.
the developer certificate.

To work around this:

- **on Windows**: click "more information", and press "Run
Anyway" button.
- **on macOS**: open the folder in Finder, hold Option and double click the
Expand Down Expand Up @@ -98,9 +98,13 @@ Example
-------
.. code:: go

package main

import (
"github.com/rusq/slackdump/v2"
"github.com/rusq/slackdump/v2/auth"
"log"
"context"
)

func main() {
Expand All @@ -109,7 +113,7 @@ Example
log.Print(err)
return
}
sd, err := New(context.Background(), provider)
sd, err := slackdump.New(context.Background(), provider)
if err != nil {
log.Print(err)
return
Expand All @@ -122,7 +126,7 @@ See |go ref|
Using Custom Logger
-------------------
Slackdump uses a simple `rusq/dlog`_ as a default logger (it is a wrapper around
the standard logger that adds `Debug*` functions).
the standard logger that adds `Debug*` functions).

If you want to use the same default logger that Slackdump uses in your
application, it is available as ``logger.Default``.
Expand All @@ -140,7 +144,7 @@ Good news is logrus_ can be plugged in straight away, as it implements the
.. code:: go

lg := logrus.New()
sd, err := New(context.Background(), provider, WithLogger(lg))
sd, err := slackdump.New(context.Background(), provider, WithLogger(lg))
if err != nil {
log.Print(err)
return
Expand Down Expand Up @@ -185,7 +189,7 @@ Bulletin Board
Messages that were conveyed with the donations:

- 25/01/2022: Stay away from `TheSignChef.com`_, ya hear, they don't pay what
they owe to their employees.
they owe to their employees.

.. _Application: https://stackoverflow.com/questions/12908881/how-to-copy-cookies-in-google-chrome
.. _`Buy me a cup of tea`: https://www.paypal.com/donate/?hosted_button_id=GUHCLSM7E54ZW
Expand Down