Skip to content

Updating readme.md #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
arleslie wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Updating readme.md #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23e731c
Changing repository url to github (current repository url requires au…
arleslie Jan 12, 2016
313090d
Fixing package name.
arleslie Jan 12, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 28 additions & 28 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
Add this on your `composer.json`:

"require": {
"coreproc/enom-sdk-php": "dev-master"
"coreproc/enom-sdk": "dev-master"
},
"repositories": [
{
"type": "vcs",
"url": "https://git.coreproc.ph/coreproc/enom-sdk-php.git"
"url": "https://github.com/CoreProc/enom-sdk-php.git"
}
]

# Usage

## Laravel 5.x users
Expand All @@ -20,27 +20,27 @@ Add this line in the `providers` array in `config/app.php`:

'providers' => [
// Other Service Providers

Coreproc\Enom\Providers\EnomServiceProvider::class,
],

Add these lines in the `facades` array in `config/app.php`:

'facades' => [
// Other Facades

'Tld' => Coreproc\Enom\Facades\Tld::class
'Domain' => Coreproc\Enom\Facades\Domain::class,
],

Then run this command to publish the config file:

php artisan vendor:publish --provider="Coreproc\Enom\Providers\EnomServiceProvider"

Set up your credentials on the published file `config/enom.php`:

<?php

return [
'userId' => env('ENOM_USER_ID', ''),
'password' => env('ENOM_PASSWORD', '')
Expand All @@ -50,9 +50,9 @@ You now have access to the facades `Tld` and `Domain` which you can use like so:

$tlds = Tld::getList();
$domains = Domain::getList();
No need to manually set up the Enom client - it's already done. Please see methods of each class below.

No need to manually set up the Enom client - it's already done. Please see methods of each class below.

## Vanilla PHP

Set up the client
Expand All @@ -62,56 +62,56 @@ Set up the client
## TLDs

$tld = new Tld($enom);

try {
$tld->authorize(['com', 'net', 'io']);
} catch (Coreproc\Enom\EnomApiException $e) {
var_dump($e->getErrors());
}

## Methods

Authorize TLDs

authorize(array $tlds)

Remove TLDs

remove(array $tlds)

Get TLD list

getList()

## Domains

$domain = new Domain($enom);

try {
$domain->check('example', 'com');
} catch (Coreproc\Enom\EnomApiException $e) {
var_dump($e->getErrors());
}

## Methods

check($sld, $tld)

getNameSpinner($sld, $tld, $options = [])

getExtendedAttributes($tld)

purchase($sld, $tld, $extendedAttributes = [])

getStatus($sld, $tld, $orderId)

getList()

getInfo($sld, $tld)

setContactInformation($sld, $tld, $contactInfo = [])

getContactInformation($sld, $tld)

getWhoIsContactInformation($sld, $tld)