Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronbushnell committed Feb 17, 2022
1 parent 11b9da2 commit 8f86993
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 1 deletion.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

📊 Export Craft data as CSVs in a snap!

<img src="docs/reports.png" width="1200" alt="An example of the reports screen before a user has initiated an export">

## ⚡️ Features

- 🏎 Reports are processed with [Query Batching](https://craftcms.com/knowledge-base/query-batching-batch-each), making exports run quickly and without exhausting your memory limit
Expand Down Expand Up @@ -78,6 +80,8 @@ return [
];
```

<img src="docs/export.png" width="1200" alt="The exports screen that is displayed when you have not exported any reports yet.">

## 🤝 Contributing

If you would like to contribute to Reporter we tried to make it as easy as possible:
Expand Down
Binary file added docs/export.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/reports.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/templates/index.twig
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<h2>No reports exist...yet!</h2>
<p>
You currently do not have any reports to export. To setup your first report you'll need to configure a <code>config/reporter.php</code> document and setup the options outlined in <a href="https://github.com/trendyminds/craft-reporter">the documentation</a>.
You currently do not have any reports to export. To setup your first report you'll need to configure a <code>config/reporter.php</code> document and setup the options outlined in <a href="https://github.com/trendyminds/craft-reporter#readme">the documentation</a>.
</p>
</div>
{% endif %}
Expand Down

0 comments on commit 8f86993

Please sign in to comment.