Skip to content

Commit

Permalink
updated the godoc documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
heycatch committed Jun 19, 2024
1 parent 4e55810 commit 003a08a
Show file tree
Hide file tree
Showing 4 changed files with 206 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### О проекте
Небольшая библиотека для взаимодействия с шикимори, написанная на языке golang.
* Работа с API происходит только через `OAuth2`.
* Работа с API происходит только через `OAuth2`. \
И начать нужно с ознакомления документации [первые шаги](https://github.com/heycatch/goshikimori/blob/master/examples/first_steps/README.md).
* Никаких зависимостей от других библиотек.
* Для тестов и сборки используется утилита [GNU make](https://www.gnu.org/software/make/manual/make.html).
Expand Down
2 changes: 1 addition & 1 deletion README_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### About
A small library for interacting with shikimori, written in golang.
* Work with API occurs only through `OAuth2`.
* Work with API occurs only through `OAuth2`. \
And you have to start by familiarizing yourself
with the documentation [first steps](https://github.com/heycatch/goshikimori/blob/master/examples/first_steps/README_en.md).
* No dependencies on other libraries.
Expand Down
5 changes: 1 addition & 4 deletions configuration.go
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,11 @@ func (c *Configuration) GetConfiguration() (string, string) {
return c.Application, c.AccessToken
}

// For GET requests the name of the application is sufficient.
// A access token is required for POST/PUT/DELETE.
//
// To register the application, follow the link from [OAuth].
//
// More information can be found in the [example].
//
// [OAuth]: https://github.com/heycatch/goshikimori#shikimori-documentation
// [OAuth]: https://github.com/heycatch/goshikimori/blob/master/examples/first_steps
// [example]: https://github.com/heycatch/goshikimori/blob/master/examples/getter_setter
func SetConfiguration(appname, token string) *Configuration {
return &Configuration{Application: appname, AccessToken: token}
Expand Down
Loading

0 comments on commit 003a08a

Please sign in to comment.