Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main'
Browse files Browse the repository at this point in the history
  • Loading branch information
Yucked committed Nov 14, 2023
2 parents fc2c306 + 8e176de commit d5fed64
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 8 deletions.
1 change: 1 addition & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ jobs:
name: Publish to GitHub
runs-on: ubuntu-latest
needs: build
if: ${{ !contains(github.event.head_commit.message, 'Update') }}

steps:
- name: Checkout
Expand Down
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,23 +25,27 @@
- Parallel & Asynchronous for faster parsing and fetching data

## `🐳 Docker:`
- Download `Dockerfile` from [here](https://github.com/Yucked/Grimoire/blob/main/Dockerfile).
- Download `docker-compose.yml` from [here](https://github.com/Yucked/Grimoire/blob/main/docker-compose.yml).
- Place both in a folder and run `docker compose up -d`.
- To build it yourself, download `Dockerfile` from [here](https://github.com/Yucked/Grimoire/blob/main/Dockerfile).
- To use pre-built images, download `docker-compose.yml` from [here](https://github.com/Yucked/Grimoire/blob/main/docker-compose.yml) and run `docker compose up -d`.

## `📸 Images:`

![image](https://github.com/Yucked/Grimoire/assets/20461656/793456f6-f632-4c70-b9d7-c08efb0ebe68)

![image](https://github.com/Yucked/Grimoire/assets/20461656/7f2ef774-fbaf-4e0c-a666-455a3a52f161)
![image](https://github.com/Yucked/Grimoire/assets/20461656/42f78ada-d431-437e-a1da-d4a3f8ea40dc)

![image](https://github.com/Yucked/Grimoire/assets/20461656/64a26e9d-5829-4e0e-92e6-9fe8f1e7cab9)


## `🤔 FAQ:`
- Can I use it? Is it production ready?
> Absolutely YES! Use it at your own risk though.
##### Is Grimoire prod ready?
Yes and no. Basic functionality is there.
- Why not some 3rd party pre-existing program that does what your program does already with support for 500 sites?
> L + ratio + too many sites + too slow + doesn't work as expected + can't relate + old UI + be better
##### Why not tachidesk-server?
I personally use tachidesk-server but I wanted more hence Grimoire!
- Can you add xyz site please?
> yeah sure, just make sure you give all the necessary information for scraping 😒
- I GOT BANNED FROM WEBSITE XYZ IP BLACKLISTED HELPPPP!!!
> refer to FAQ #1, welcome to the club! Use a VPN next time.

0 comments on commit d5fed64

Please sign in to comment.