Skip to content

Commit 4d88e6b

Browse files
committed
Update README.md and CHANGELOG.md, add how to upgrade to v1.0.0 docs
1 parent 4677360 commit 4d88e6b

File tree

2 files changed

+47
-2
lines changed

2 files changed

+47
-2
lines changed

CHANGELOG.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@
88

99
### UPGRADE
1010

11-
- Change `use PPSpaces\Repositories\Model as Repository` to `use PPSpaces\Repositories\Repository`
11+
```diff
12+
- use PPSpaces\Repositories\Model as Repository;
13+
+ use PPSpaces\Repositories\Repository;
14+
```
1215

1316
### DEPRECIATED
1417

README.md

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@
1313
- [Use Case](#use-case)
1414
- [Help](#help)
1515

16+
## Upgrade Notice
17+
18+
- [How to upgrade?](#upgrade-notice)
19+
1620
## What is the Repository Design Pattern
1721

1822
![Repository Design Pattern](assets/repository_pattern.png)
@@ -92,7 +96,6 @@ Update `UserRepository` logic:
9296
```php
9397
namespace App\Http\Repositories;
9498

95-
use App\User;
9699
use PPSpaces\Repositories\Model as Repository;
97100

98101
class UserRepository extends Repository {
@@ -177,6 +180,45 @@ public function show(UserRepository $user)
177180
}
178181
```
179182

183+
## Upgrade Notice
184+
185+
> Upgrade from `v0.0.9` or earilier to `v1.0.0`
186+
187+
### Rename main `Repository` namespace
188+
189+
```diff
190+
namespace App\Http\Repositories;
191+
192+
- use App\User;
193+
194+
- use PPSpaces\Repositories\Model as Repository;
195+
+ use PPSpaces\Repositories\Repository;
196+
197+
class UserRepository extends Repository {
198+
199+
+ /**
200+
+ * The user model instance.
201+
+ *
202+
+ * @var \App\User
203+
+ */
204+
+ protected $model = "App\User";
205+
206+
- protected $user;
207+
208+
- public function __construct(User $user) {
209+
- $this->user = $user;
210+
- }
211+
212+
public function index()
213+
{
214+
// `$this->users->all()` will always resolved the same result as `$this->users->get()`
215+
- return $this->users->all();
216+
+ return $this->users->get();
217+
}
218+
219+
}
220+
```
221+
180222
## Help
181223

182224
```

0 commit comments

Comments
 (0)