README ready for production
This commit is contained in:
Maximous Black
parent
253e9328c4
commit
49ac582105
84
README.md
84
README.md
|
|
@ -1,33 +1,75 @@
|
|||
# Website
|
||||
<div align="center">
|
||||
<a href="https://piracy.now.sh"><img width="200" src="https://piracy.now.sh/logo.svg" alt="arrrr!"></a>
|
||||
<h1 align="center">Piracy</h1>
|
||||
<h3 align="center">It's illegal cuz they can't tax you!</h3>
|
||||
</div>
|
||||
|
||||
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
|
||||
<div align="center">
|
||||
<a href="https://web.archive.org/web/*/https://piracy.now.sh/"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/maximousblk/piracy/archive?label=Internet%20Archive&logo=github%20actions&logoColor=fff&style=for-the-badge"></a>
|
||||
<a href="https://github.com/maximousblk/piracy"><img src="https://img.shields.io/github/stars/maximousblk/piracy?color=555&logo=github&style=for-the-badge" alt="GitHub stars"></a>
|
||||
<a href="https://twitter.com/intent/tweet?text=Head over to https://piracy.now.sh/ for amazing %23piracy links and resources!"><img src="https://img.shields.io/badge/-tweet%20about%20this-1da1f2?logoColor=fff&logo=twitter&labelColor=1da1f2&style=for-the-badge" alt="Tweet"></a>
|
||||
</div>
|
||||
|
||||
### Installation
|
||||
This website is a collection of the best digital piracy resources. This will help you get started on your pirate voyage.
|
||||
|
||||
```
|
||||
$ yarn
|
||||
```
|
||||
## Mirrors
|
||||
|
||||
### Local Development
|
||||
Repo mirrors:
|
||||
|
||||
```
|
||||
$ yarn start
|
||||
```
|
||||
- [maximousblk/piracy@github](https://github.com/maximousblk/piracy) - official
|
||||
- [maximousblk/piracy@gitlab](https://gitlab.com/maximousblk/piracy)
|
||||
|
||||
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
|
||||
Website mirrors:
|
||||
|
||||
### Build
|
||||
- [piracy.now.sh](https://piracy.now.sh/) - official
|
||||
- [piracy.netlify.app](https://piracy.netlify.app/)
|
||||
- [piracy.onrender.com](https://piracy.onrender.com/)
|
||||
- [piracy.on.fleek.co](https://piracy.on.fleek.co/)
|
||||
|
||||
```
|
||||
$ yarn build
|
||||
```
|
||||
## FAQ
|
||||
|
||||
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
||||
> Why was this even created?
|
||||
|
||||
### Deployment
|
||||
Research purposes... :wink:
|
||||
|
||||
```
|
||||
$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
|
||||
```
|
||||
> Is this a biased list?
|
||||
|
||||
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
|
||||
Somewhat. I don't know everything about piracy and can be a little resistive while adding new links.
|
||||
|
||||
> Why can't I do a full text search on the website?
|
||||
|
||||
A full-text search function is planned.
|
||||
The website uses vuepress for easy maintainance and deployment.
|
||||
Vuepress currently only supports header search and algolia pluggin.
|
||||
I don't know how to integrate algolia in the current workflow.
|
||||
Any help regarding this will be much appreciated.
|
||||
Untill then you will have to search via GitHub or GitLab repository search.
|
||||
|
||||
## Contribute
|
||||
|
||||
Contributions are welcome! Read the [contribution guidelines](contributing.md) to make sure nothing goes wrong.
|
||||
|
||||
For discussion, feedback or if you come across dead links please head over to [issues](https://github.com/maximousblk/piracy/issues/) page.
|
||||
|
||||
## Project structure
|
||||
|
||||
- [.github/](.github/) - Github Workflow files.
|
||||
- [docs/](docs/) - Main website Source code and lists.
|
||||
- [.gitignore](.gitignore) - gitignore file.
|
||||
- [LICENSE](LICENSE) - License file.
|
||||
- [now.json](docs/now.json) - Configuration file for Vercels Now.
|
||||
- [package-lock.json](docs/package-lock.json) - Lock file for package manager.
|
||||
- [package.json](docs/package.json) - Package manager configurations.
|
||||
- [README.md](README.md) - This file.
|
||||
|
||||
## Disclaimer
|
||||
|
||||
All the information on this website is purely for informational purposes and is not intended to support copyright infringement. I, [Maximous Black](https://maximousblk.github.io/), the owner of this project is not responsible for and in no way associated to any external links or their content. The inclusion of any links does not necessarily imply a recommendation or endorse the views expressed within them. I have no control over the nature, content and availability of other websites. If you dislike the information this website provides then please contact the corresponding website's owner/webmaster/hoster directly and fill a DMCA takedown request.
|
||||
|
||||
If you are a copyright owner or an agent thereof, and you believe that your work is accessible through this project in a way that constitutes copyright infringement, you may [create a GitHub issue](https://github.com/maximousblk/piracy/issues/new) to notify me.
|
||||
|
||||
## License
|
||||
|
||||
[](LICENSE)
|
||||
|
||||
To the extent possible under law, [Maximous Black](https://maximousblk.github.io/) has waived all copyright and related or neighboring rights to this project.
|
||||
|
|
|
|||
Reference in New Issue