Skip to content

Commit

Permalink
Add a small section about LINQPad.
Browse files Browse the repository at this point in the history
  • Loading branch information
Zastai committed May 5, 2020
1 parent 3c940be commit 1f497cf
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion UserGuide.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MetaBrainz.MusicBrainz User Guide

## Getting started
## Getting Started

All the real functionality is exposed by the `Query` class. There are some static properties to set up defaults for the web service
you want to access. If you are accessing the official MusicBrainz site, no changes are needed.
Expand All @@ -21,6 +21,24 @@ If you intend to create multiple `Query` objects, you can also set up a default
property, so you can just use `new Query()` to create instances. You must ensure that it's a valid user agent string
(`Name/Version (Contact)`); requests without one may be subject to rate limiting.

### Software Suggestion

When playing around with these APIs and familiarizing yourself with the various objects involved, it can be very useful to get a
nice overview of the objects' structures. Rather than writing some code and relying on the debugger's interface to browse the
contents, I can strongly recommend [LINQPad](https://www.linqpad.net/). It's free (although there is a premium version with more
advanced features).

With it, you just set up a query that references the `MetaBrainz.MusicBrainz` assembly and the corresponding namespace.
Then you write the code to set up a query object (like above), and call one of its methods, chaining a call to `Dump()` to those
for which you want the result to be formatted in the output window. Pressing `F5` will then run that code, and provide you with
a nice view of the object(s) in question.

For example:
```c#
var q = new Query("Red Stapler", "19.99", "mailto:[email protected]");
q.FindReleaseGroups("releasegroup:\"Office Space\"").Dump();
```


## Accessing Data

Expand Down

0 comments on commit 1f497cf

Please sign in to comment.