Skip to content

update readme to include information about client implementation#21

Open
lordrhodos wants to merge 2 commits into
starweb:masterfrom
lordrhodos:feature/readme-update
Open

update readme to include information about client implementation#21
lordrhodos wants to merge 2 commits into
starweb:masterfrom
lordrhodos:feature/readme-update

Conversation

@lordrhodos

Copy link
Copy Markdown
Contributor

No description provided.

@felixsand felixsand left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! 👍

@felixsand felixsand left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just remembered one thing!

Comment thread README.md

# Documentation
The Starweb Shop API SDK uses an auto generated client
The Starweb Shop API SDK uses an auto generated client based on [Jane](https://jane.readthedocs.io/) at its core.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we also should add something here of how to use it:

$credentials = new ClientCredentials('my-client-id', 'my-client-secret');
$starweb = Starweb::create($credentials, 'https://my-shop.starwebserver.se/api/v2');
$client = $starweb->getClient();

$products = $client->listProducts(); // fetch products

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would have saved me a LOT of time when I tried to get started 😉

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added some documentation how to get started

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants