Skip to content

Commit

Permalink
Add note about mjs files
Browse files Browse the repository at this point in the history
  • Loading branch information
MGatner committed Jul 31, 2022
1 parent 7e4c495 commit 188d1dc
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,27 +38,34 @@ Or, install manually by downloading the source files and adding the directory to
Once the files are downloaded and included in the autoload, run any library migrations
to ensure the database is setup correctly:
```shell
> php spark migrate -all
> php spark migrate --all
```

Finally, run the seeder to install necessary database settings:
Run the seeder to install necessary database settings:
```shell
php spark db:seed "Tatter\Files\Database\Seeds\FileSeeder"
```

**NOTE**: If your project is part of a tracking repository you probably want to add the file
storage to your **.gitignore**
```
writable/files/*
!writable/files/index.html
Finally, run the framework's Publish Command to copy assets to your public directory:
```shell
php spark publish
```

**NOTE**: You may need to adjust your **Publisher.php** config file to support `.mjs` files.

## Configuration (optional)

The library's default behavior can be altered by extending its config file. Copy
**examples/Files.php** to **app/Config/** and follow the instructions
in the comments. If no config file is found in **app/Config** the library will use its own.

**NOTE**: If your project is part of a tracking repository you probably want to add the file
storage to your **.gitignore**
```
writable/files/*
!writable/files/index.html
```

## Usage

Default routes:
Expand Down

0 comments on commit 188d1dc

Please sign in to comment.