Skip to content

Commit

Permalink
Readme correction
Browse files Browse the repository at this point in the history
  • Loading branch information
liebki committed Aug 11, 2022
1 parent e33a429 commit bd52387
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 69 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@

# RawgNET
An API-Wrapper to get a game including all it's data from https://rawg.io
A wrapper for the API of wrag.io, to get a game including all it's data

## Technologies

Expand All @@ -12,6 +11,9 @@ An API-Wrapper to get a game including all it's data from https://rawg.io

## Features

### New
- Thanks to sgamesdev, I got reminded that the achievements are missing, those are included by now

### General
- Get a "Game" object including the complete data like images, description and more..

Expand All @@ -20,12 +22,16 @@ An API-Wrapper to get a game including all it's data from https://rawg.io
## Example

```
using (RawgClient client = new(new RawgClientOptions("API KEY OF RAWG.IO")))
using (RawgClient client = new(new RawgClientOptions("YOUR KEY FROM https://rawg.io/login?forward=developer")))
{
Game game = client.GetGameData("NAME OF GAME");
string query = "gtav";
Console.WriteLine($"Querying for: {query}");
Game game = client.GetGameData(query, true);
if (!object.Equals(game, null))
{
Console.WriteLine("Imagelink: " + game.BackgroundImage);
Console.WriteLine($"Output for: {game.Name} | {game.NameOriginal}\n");
Console.WriteLine(game.ToString());
}
}
```
Expand All @@ -52,7 +58,6 @@ At https://rawg.io/apidocs just press the "Get API Key" button.

## Roadmap

- Speed up code
- Make code more clean
- Make code more clean especially the ""RawgRequest"" method!
- Export "Newtonsoft.Json" nuget package with library
- More to come..
63 changes: 1 addition & 62 deletions RawgNET/README.md
Original file line number Diff line number Diff line change
@@ -1,63 +1,2 @@
# RawgNET
A wrapper for the API of wrag.io, to get a game including all it's data

## Technologies

### Created using
- .NET Core 6.0

### Nuget(s)
- Newtonsoft.Json (Needs to be added to your project too, until I figure out why)

## Features

### New
- Thanks to sgamesdev, I got reminded that the achievements are missing, those are included by now

### General
- Get a "Game" object including the complete data like images, description and more..

## Usage

## Example

```
using (RawgClient client = new(new RawgClientOptions("YOUR KEY FROM https://rawg.io/login?forward=developer")))
{
string query = "gtav";
Console.WriteLine($"Querying for: {query}");
Game game = client.GetGameData(query, true);
if (!object.Equals(game, null))
{
Console.WriteLine($"Output for: {game.Name} | {game.NameOriginal}\n");
Console.WriteLine(game.ToString());
}
}
```

## FAQ

#### Does this work on every OS?

I created this on windows 10 and tested it on other windows 10 machines, I cant guarantee anything for other operating systems or versions. But it should work everywhere, where Core 6 works.

#### Where do I get an API-Key?

At https://rawg.io/apidocs just press the "Get API Key" button.

## License

**Software:** RawgNET

**License:** GNU General Public License v3.0

**Licensor:** Kim Mario Liebl

[GNU](https://choosealicense.com/licenses/gpl-3.0/)

## Roadmap

- Make code more clean especially the ""RawgRequest"" method!
- Export "Newtonsoft.Json" nuget package with library
- More to come..
The wrapper, to use in projects.
2 changes: 2 additions & 0 deletions RawgNetDemo/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Demo
The demo project, to test out the functions.

0 comments on commit bd52387

Please sign in to comment.