From f82a189d2c5f3c40e27733c35e058f75d62fd459 Mon Sep 17 00:00:00 2001 From: yayuyokitano <69117606+yayuyokitano@users.noreply.github.com> Date: Wed, 25 Nov 2020 14:36:55 +0800 Subject: [PATCH] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1456184f..8a40f6ec 100644 --- a/README.md +++ b/README.md @@ -27,9 +27,11 @@ The library exports a single class. This class, in turn, creates instances of a ```ts import LastFMTyped from "lastfm-typed"; -const lastfm = new LastFMTyped(api_key, api_secret); //insert key and secret here +const lastfm = new LastFMTyped(api_key, api_secret, UserAgent); //insert key, secret, and user agent here ``` +For user agent, please initialize this with an easily identifiable name (preferably one that would lead to your program if googled). You can choose to not set one, in which case `lastfm-typed-npm` will be set as the user agent. This is probably the best idea if your program is not public. + Then we can call methods as needed. ### Examples