Skip to content

Commit

Permalink
Add opensource.byjg.com github page
Browse files Browse the repository at this point in the history
  • Loading branch information
byjg committed Nov 29, 2018
1 parent e3a891f commit 2b3d83c
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 12 deletions.
23 changes: 11 additions & 12 deletions README.md
Expand Up @@ -6,17 +6,18 @@
[![Build Status](https://travis-ci.org/byjg/anydataset.svg?branch=master)](https://travis-ci.org/byjg/anydataset)
[![Code Coverage](https://scrutinizer-ci.com/g/byjg/anydataset/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/byjg/anydataset/?branch=master)

## Description

Anydataset Core Module. Anydataset is an agnostic data source abstraction layer in PHP.

## Features
# Features

- Access different data sources using the same interface.
- Iterable results
- Convert results to array

## Current Implementations
# Current Implementations

{:.table}

| Object | Data Source | Read | Write | Reference |
| ---------------------- | --------------------- |:----:|:-----:| ----------------------- |
Expand All @@ -32,9 +33,9 @@ Anydataset Core Module. Anydataset is an agnostic data source abstraction layer
| KeyValueInterface | NoSql Key/Value Based | yes | yes | [Github](https://github.com/byjg/anydataset-nosql) |


## Examples
# Examples

### Iterating with foreach
## Iterating with foreach

```php
<?php
Expand All @@ -46,7 +47,7 @@ foreach ($iterator as $row) {
}
```

### Filtering results
## Filtering results

```php
<?php
Expand All @@ -55,15 +56,15 @@ $filter->addRelation("field1", \ByJG\AnyDataset\Core\Enum\Relation::EQUAL, 10);
$iterator2 = $dataset->getIterator($filter);
```

### Conveting to Array
## Conveting to Array

```php
<?php
$iterator = $dataset->getIterator();
print_r($iterator->toArray());
```

### Iterating with While
## Iterating with While

```php
<?php
Expand All @@ -76,13 +77,11 @@ while ($iterator->hasNext()) {
```


## Install
# Install

Just type: `composer require "byjg/anydataset=4.0.*"`

#### Running Unit tests

Running the Unit tests
# Running Unit tests

```php
vendor/bin/phpunit
Expand Down
53 changes: 53 additions & 0 deletions _config.yml
@@ -0,0 +1,53 @@
name: anydataset

project:
version: 4.0.0
download_url: https://github.com/byjg/anydataset/releases

license:
software: MIT
software_url: https://opensource.org/licenses/MIT

docs: MIT
docs_url: https://opensource.org/licenses/MIT

git_edit_address: https://github.com/byjg/anydataset/blob/master/

links:
header:
- title: GitHub
url: https://github.com/byjg/anydataset
- title: ByJG
url: https://opensource.byjg.com/
footer:
- title: GitHub
url: https://github.com/byjg/anydataset
- title: Issues
url: https://github.com/byjg/anydataset/issues

ui:
header:
color1: "#080331"
color2: "#0033cc"
trianglify: true

social:
github:
user: byjg
repo: anydataset
twitter:
enabled: false
via:
hash: opensourcebyjg
account:
facebook:
enabled: false
profileUrl:

analytics:
google: UA-130014324-1

# Build settings
markdown: kramdown
remote_theme: allejo/jekyll-docs-theme

0 comments on commit 2b3d83c

Please sign in to comment.