Skip to content

Commit

Permalink
Updated readme, package readme, relaase notes and version number (#107)
Browse files Browse the repository at this point in the history
  • Loading branch information
akamsteeg committed Jul 14, 2024
1 parent 1b9b340 commit 7e4ef63
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 2 deletions.
6 changes: 6 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,12 @@ using (var client = new HaveIBeenPwnedClient(settings))
// Get breaches for an account, excluding unverified breaches
var breaches = await client.GetBreachesAsync("test@example.com", BreachMode.ExcludeUnverified); // Requires an API key
// Get the subscribed domains for an API key
var domains = await client.GetSubscribedDomainsAsync)(); // Requires an API key
// Get breached users from a domain the API key is subscribed to
var breachedUsersOfDomain = await client.GetBreachedDomainUsersAsync("example.com"); // Requires an API key
// Get pastes for an email address
var pastes = await client.GetPastesAsync("test@example.com"); // Requires an API key
Expand Down
6 changes: 6 additions & 0 deletions src/AtleX.HaveIBeenPwned/packageReadme.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,12 @@ using (var client = new HaveIBeenPwnedClient(settings))
// Get breaches for an account, excluding unverified breaches
var breaches = await client.GetBreachesAsync("test@example.com", BreachMode.ExcludeUnverified); // Requires an API key
// Get the subscribed domains for an API key
var domains = await client.GetSubscribedDomainsAsync)(); // Requires an API key
// Get breached users from a domain the API key is subscribed to
var breachedUsersOfDomain = await client.GetBreachedDomainUsersAsync("example.com"); // Requires an API key
// Get pastes for an email address
var pastes = await client.GetPastesAsync("test@example.com"); // Requires an API key
Expand Down
12 changes: 10 additions & 2 deletions src/Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,19 @@
<PackageReadmeFile>packageReadme.md</PackageReadmeFile>
<PackageIcon>packageicon.png</PackageIcon>

<Version>8.1.1</Version>
<Version>9.0.0</Version>

<PackageReleaseNotes>
9.0.0:
- [Feature] Added support getting subscribed domains and their breached users (#104)
- [Feature] Added basic telemetry so users can observe the usage and performance of the library (#102)
- [Feature] Updated documentation (#97, #106)
- [Feature] Implemented '==' and '!=' operators on models (#100)
- [Feature] Add a package icon (#108)
- [Fix] Performance improvements (#96, #98, #99)

8.1.1:
- [Feature] Internal (performance) improvements. (#94,and other commits)
- [Feature] Internal (performance) improvements. (#94 and other commits)

8.1.0:
- [Feature] Add .NET 8+ compatiblity
Expand Down

0 comments on commit 7e4ef63

Please sign in to comment.