Skip to content

Commit

Permalink
Minor updates to the README file
Browse files Browse the repository at this point in the history
  • Loading branch information
rpkoller committed Jun 13, 2023
1 parent 173b42d commit 71933fc
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ This repository provides an addon to use [@Spidergram](https://github.com/autogr
> While it can be used to crawl any website, we (the folks at [Autogram](https://autogram.is/)) designed it specifically for "ten websites in a trench coat" scenarios where a web property encompasses multiple CMSs, multiple domains, and multiple design systems, maintained by multiple teams.
## Installation
0. Make sure [Docker](https://ddev.readthedocs.io/en/stable/users/install/docker-installation/) and [DDEV](https://ddev.readthedocs.io/en/stable/users/install/ddev-installation/) are installed.

1. Create a new directory and go into it. For simplicity reasons I am using the name `spidergram` for this guide. You are able to use any other name here.
```
mkdir spidergram && cd spidergram
Expand Down Expand Up @@ -73,7 +75,7 @@ it is ensured that the URL set in the config.json is in line with the overall pr

## TODO
- [ ] Figure out the best approach how to upgrade Spidergram and it's dependencies for an already existing Spidergram DDEV instance and update the README accordingly (_I have to wait for the next Spidergram release being able to test that_).
- [ ] Expand the number of settings in the `spidergram.config.yaml`. At the moment I've only using the default values found at https://github.com/autogram-is/create-spidergram/tree/main/templates
- [ ] Expand the number of available settings in the `spidergram.config.yaml`. At the moment I am only using the default values from an old template found at https://github.com/autogram-is/create-spidergram/tree/main/templates.

## Contributing
Any feedback in regard to bugs and potential improvements is welcome.
Expand Down

0 comments on commit 71933fc

Please sign in to comment.