Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@cmadh
cmadh committed Apr 17, 2023
1 parent 6157f44 commit 98a8280
Showing 1 changed file with 54 additions and 148 deletions.
202 changes: 54 additions & 148 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,178 +5,84 @@

---

<div align="center">

[![Build](https://github.com/liquiidio/AtomicAssetsApiClient/actions/workflows/build.yml/badge.svg)](https://github.com/liquiidio/AtomicAssetsApiClient/actions/workflows/build.yml)
[![Test](https://github.com/liquiidio/AtomicAssetsApiClient/actions/workflows/test.yml/badge.svg)](https://github.com/liquiidio/AtomicAssetsApiClient/actions/workflows/test.yml)
[![Build documents](https://github.com/liquiidio/AtomicAssetsApiClient/actions/workflows/docs.yml/badge.svg)](https://github.com/liquiidio/AtomicAssetsApiClient/actions/workflows/docs.yml)
[![Deploy](https://github.com/liquiidio/AtomicAssetsApiClient/actions/workflows/deploy.yml/badge.svg)](https://github.com/liquiidio/AtomicAssetsApiClient/actions/workflows/deploy.yml)

</div>

One Paragraph of the package description/overview.
Reference any services and additional sources used by the package .Can be a link
# AtomicAssetsApiClient

.NET and Unity3D-compatible (Desktop, Mobile, WebGL) ApiClient for AtomicAssets


# Installation

**_Requires Unity 2019.1+ with .NET 4.x+ Runtime_**

This package can be included into your project by either:

1. Installing the package via Unity's Package Manager (UPM) in the editor (recommended).
2. Importing the .unitypackage which you can download [here](https://github.com/liquiidio/AtomicAssetsApiClient/releases/latest/download/atomicassets.unitypackage).
3. Manually add the files in this repo.
4. Installing it via NuGet.

---

### 1. Installing via Unity Package Manager (UPM).
In your Unity project:
1. Open the Package Manager Window/Tab

![image](https://user-images.githubusercontent.com/74650011/208429048-37e2277c-3e10-4794-97e7-3ec87f55f8c9.png)

2. Click on + icon and then click on "Add Package From Git URL"

![image](https://user-images.githubusercontent.com/74650011/208429298-76fe1101-95f3-4ab0-bbd5-f0a32a1cc652.png)

3. Enter URL: `https://github.com/liquiidio/AttomicAssetsApiClient.git#upm`

---
### 2. Importing the Unity Package.
Download the [UnityPackage here](https://github.com/liquiidio/AtomicAssetsApiClient/releases/latest/download/atomicassets.unitypackage).

Then in your Unity project:

1. Open up the import a custom package window

![image](https://user-images.githubusercontent.com/74650011/208430044-caf91dd9-111e-4224-8441-95d116dbec3b.png)

2. Navigate to where you downloaded the file and open it.

![image](https://user-images.githubusercontent.com/86061433/217043716-5b973473-4644-461b-af14-df8bf123a4b6.jpg)


3. Check all the relevant files needed (if this is a first time import, just select ALL) and click on import.

![image](https://user-images.githubusercontent.com/86061433/217044240-12aeadc4-40ae-4624-9b98-4250eea73d33.jpg)


---

### 3. Install manually.

Download [the latest Release](https://github.com/liquiidio/AtomicAssetsApiClient/releases/latest).

Then in your Unity project, copy the sources from `AtomicAssetsApiClient` into your Unity `Assets` directory.

---

### 4. Install via NuGet (for Standard .NET users only - No Unity3D)

#### .NET CLI

`> dotnet add package Liquiid.io.AtomicAssets --version 1.0.24`

#### Package Manager

`PM> Install-Package Liquiid.io.AtomicAssets -Version 1.0.24`

---

# Usage
## Usage

The entry point to the APIs is in the AtomicAssetsApiFactory. You can initialise any supported API from there.
You can then call any endpoint from the initialised API.
Each endpoint has its own set of parameters that you may build up and pass in to the relevant function.

---
## Examples
### Getting assets available for trading on the exchange
```csharp

# Examples

## Example calling the /v1/assets endpoint
### Initialise the Assets API
```csharp
var assetsApi = AtomicAssetsApiFactory.Version1.AssetsApi;
```

### Call the assets endpoint
```csharp
var assets = await assetsApi.Assets();
```

### Print all asset IDs
```csharp
assets.Data.ToList().ForEach(a => Console.WriteLine(a.AssetId));
```

##### Example output

AtomicMarket
async Task GettingAllTheAssets()
{
// Initialize the v1 assets API
var assetsApi = AtomicAssetsApiFactory.Version1.AssetsApi;

1099567200113
//Getting all the assets that are available for trading on the exchange.
var assets = await assetsApi.Assets();

1099567200112
// Print their IDs on the console.
assets.Data.ToList().ForEach(a => Console.WriteLine(a.AssetId));
}

1099567200111

1099567200110
```

### Getting a filtered assets list that is available for trading
```csharp

1099567200109
async Task GettingFilteredAssetsList()
{
// Initialize the v1 assets API
var assetsApi = AtomicAssetsApiFactory.Version1.AssetsApi;

1099567200108
// Build up the AssetsParameters with the AssetsUriParameterBuilder
// This can be used to fine tune the kind of results we want
// For example, here were limiting the results to just five assets
// More information can be found on the documentation
var builder = new AssetsUriParameterBuilder().WithLimit(5);

1099567200107
//Getting all the assets that are available for trading on the exchange.
var assets = await assetsApi.Assets(builder);

1099567200106
// Print their IDs on the console.
assets.Data.ToList().ForEach(a => Console.WriteLine(a.AssetId));
}

```

## Example calling the /v1/assets endpoint with parameters
### Initialise the Assets API
```csharp
var assetsApi = AtomicAssetsApiFactory.Version1.AssetsApi;
```

### Build up the AssetsParameters with the AssetsUriParameterBuilder
```csharp
var builder = new AssetsUriParameterBuilder().WithLimit(1);
```

### Call the assets endpoint, passing in the builder
```csharp
var assets = await assetsApi.Assets(builder);
```

### Print all asset IDs
```csharp
assets.Data.ToList().ForEach(a => Console.WriteLine(a.AssetId));
```
### Getting an Offer
```csharp

##### Example output

1099567200114

1099567200113

1099567200112
async Task GetOffer(string offerId)
{

1099567200111
// Initialize the v1 offers API
var api = AtomicAssetsApiFactory.Version1.OffersApi;

1099567200110
// Call the offers endpoint passing the offerId as an input
var sales = await api.Offer(offerId);

1099567200109
// Access different informations about the offer using the Data property in the result
Console.WriteLine(sales.Data.SenderName);
}

1099567200108
```
### Unity Examples

Our unity packages come with examples to help you get started as quickly as possible.

An example showing the result for searching an Asset with ID "#1099849109724"

<img width="853" alt="image" src="https://user-images.githubusercontent.com/31707324/213101482-0371d6cb-4981-4ea5-af0d-688092087b67.png">

1099567200107
An example showing the result for searching a Collection with Name "mrpotatogame"

1099567200106
<img width="847" alt="image" src="https://user-images.githubusercontent.com/31707324/213101918-98ef30b5-d1ca-4b31-b4c7-2895a3681e89.png">


[build-badge]: https://github.com/mkosir/react-parallax-tilt/actions/workflows/build.yml/badge.svg
[build-url]: https://github.com/mkosir/react-parallax-tilt/actions/workflows/build.yml
[test-badge]: https://github.com/mkosir/react-parallax-tilt/actions/workflows/test.yml/badge.svg
[test-url]: https://github.com/mkosir/react-parallax-tilt/actions/workflows/test.yml

0 comments on commit 98a8280

Please sign in to comment.