Skip to content
This repository was archived by the owner on Apr 15, 2025. It is now read-only.

Commit 923f85f

Browse files
committed
Clarifications
1 parent 56b784e commit 923f85f

File tree

2 files changed

+8
-22
lines changed

2 files changed

+8
-22
lines changed

README.md

Lines changed: 5 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,21 @@
11
# laravel-db-uri
22
Package to translate a database URI into database config values.
33

4-
This is meant to help prevent the need for manually parsing database URIs that come from Heroku or are just more convenient
4+
This is meant to help prevent the need for manually parsing database URIs, like the ones that come from Heroku or AWS.
55
to use than manually parsing a URI into it's host, password, username, port, (etc.) components.
66

7-
This __will overwrite__, at runtime, any `default` database connection values for `host`, `port`, `username`, `password`, and `database`
8-
9-
__THIS PACKAGE HAS NOT BEEN RELEASED PUBLICLY AND CANNOT YET BE INSTALLED VIA COMPOSER WITHOUT ROOTINC REPO ACCESS__
7+
This __will override__, at runtime, any `default` database connection values for `host`, `port`, `username`, `password`, and `database`
108

119
## Requirements
1210
(package will likely work with prior versions of Laravel and PHP but is untested)
13-
- PHP 7.1.3
14-
- Laravel 5.8
11+
- PHP >= 7.1.3
12+
- Laravel >= 5.6
1513

1614
## Installation
17-
```
18-
// composer.json
19-
...
20-
"repositories": [
21-
{
22-
"type": "git",
23-
"url": "git@github.com:rootinc/laravel-db-uri.git"
24-
}
25-
],
26-
...
27-
```
2815
`$ composer require rootinc/laravel-db-uri`
29-
You may, then, need to authenticate to Github at the command line.
30-
3116

3217
## Configuration
33-
The package will automatically map the `default` driver to the parsed values from the environment variable `DATABASE_URL`.
18+
The package will automatically map the parsed values from the environment variable `DATABASE_URL` to the `default` database connection.
3419

3520
Add a `DATABASE_URL` entry to your `.env` or server environment with a URI to your default database.
3621
`DATABASE_URL=postgresql://username:password@localhost:5432/database-name`

composer.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"name": "rootinc/laravel-db-uri",
3-
"description": "Translates a database URI into database config values.",
3+
"description": "Translates a database URI into Laravel database driver values.",
4+
"keywords": ["php", "laravel", "database", "env"],
45
"type": "library",
56
"require": {
67
"php": "^7.1.3",
@@ -9,7 +10,7 @@
910
"license": "MIT",
1011
"authors": [
1112
{
12-
"name": "Jared Rosenberg",
13+
"name": "Root Inc.",
1314
"email": "jrosenberg@rootinc.com"
1415
}
1516
],

0 commit comments

Comments
 (0)