Update README.md

This commit is contained in:
Nick Sweeting 2019-01-22 22:08:27 -05:00 committed by GitHub
parent 1f80535038
commit e94cfdc90d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,18 +1,14 @@
<div align="center"> <div align="center">
<img src="https://i.imgur.com/PVO88AZ.png" height="200px"/>
# ArchiveBox <br/> <sub><img src="https://nicksweeting.com/images/archive.png" height="20px"/> The open source self-hosted web archive <img src="https://nicksweeting.com/images/archive.png" height="20px"/></sub> # ArchiveBox <br/> <sub><img src="https://nicksweeting.com/images/archive.png" height="20px"/> The open source self-hosted web archive <img src="https://nicksweeting.com/images/archive.png" height="20px"/></sub>
[![Github Stars](https://img.shields.io/github/stars/pirate/ArchiveBox.svg) ![Activity](https://img.shields.io/github/last-commit/pirate/ArchiveBox.svg) ![Github](https://img.shields.io/badge/Open_source-Free-green.svg?logo=github) ![License](https://img.shields.io/github/license/pirate/ArchiveBox.svg) ![Language](https://img.shields.io/badge/python-3.5%20%7C%203.6%20%7C%203.7-yellow.svg) ![Chromium](https://img.shields.io/badge/chromium-%3E%3D65-silver.svg) ![Docker](https://img.shields.io/badge/docker-all%20platforms-silver.svg?logo=docker)](https://github.com/pirate/ArchiveBox) [![Github Stars](https://img.shields.io/github/stars/pirate/ArchiveBox.svg) ![Activity](https://img.shields.io/github/last-commit/pirate/ArchiveBox.svg) ![Github](https://img.shields.io/badge/Open_source-Free-green.svg?logo=github) ![License](https://img.shields.io/github/license/pirate/ArchiveBox.svg) ![Language](https://img.shields.io/badge/python-3.5%20%7C%203.6%20%7C%203.7-yellow.svg) ![Chromium](https://img.shields.io/badge/chromium-%3E%3D65-silver.svg) ![Docker](https://img.shields.io/badge/docker-all%20platforms-silver.svg?logo=docker)](https://github.com/pirate/ArchiveBox)
<img src="https://i.imgur.com/PVO88AZ.png" height="200px"/>
"Your own personal Way-Back Machine" "Your own personal Way-Back Machine"
▶️ [Quickstart](https://github.com/pirate/ArchiveBox/wiki/Quickstart) | [Details](https://github.com/pirate/ArchiveBox/wiki) | [Configuration](https://github.com/pirate/ArchiveBox/wiki/Configuration) | [Troubleshooting](https://github.com/pirate/ArchiveBox/wiki/Troubleshooting) ▶️ [Quickstart](https://github.com/pirate/ArchiveBox/wiki/Quickstart) | [Details](https://github.com/pirate/ArchiveBox/wiki) | [Configuration](https://github.com/pirate/ArchiveBox/wiki/Configuration) | [Troubleshooting](https://github.com/pirate/ArchiveBox/wiki/Troubleshooting) | [Demo](https://archive.sweeting.me) | [Website](https://archivebox.io/) | [Github](https://github.com/pirate/ArchiveBox/) | [Changelog](https://github.com/pirate/ArchiveBox/wiki/Changelog) | [Roadmap](https://github.com/pirate/ArchiveBox/wiki/Roadmap)
💻 [Demo](https://archive.sweeting.me) | [Website](https://archivebox.io/) | [Github](https://github.com/pirate/ArchiveBox/) | [Changelog](https://github.com/pirate/ArchiveBox/wiki/Changelog) | [Roadmap](https://github.com/pirate/ArchiveBox/wiki/Roadmap)
<small><i>(Recently [renamed](https://github.com/pirate/ArchiveBox/issues/108) from `Bookmark Archiver`))</i></small>
--- ---
@ -58,7 +54,7 @@ All the saved content is static and indexed with JSON files, so it lives forever
[DEMO: archive.sweeting.me](https://archive.sweeting.me) [DEMO: archive.sweeting.me](https://archive.sweeting.me)
To get startarted, you can install [automatically](https://github.com/pirate/ArchiveBox/wiki/Quickstart), follow the [manual instructions](https://github.com/pirate/ArchiveBox/wiki/Install), or use [Docker](https://github.com/pirate/ArchiveBox/wiki/Docker). To get started, you can install [automatically](https://github.com/pirate/ArchiveBox/wiki/Quickstart), follow the [manual instructions](https://github.com/pirate/ArchiveBox/wiki/Install), or use [Docker](https://github.com/pirate/ArchiveBox/wiki/Docker).
```bash ```bash
git clone https://github.com/pirate/ArchiveBox.git git clone https://github.com/pirate/ArchiveBox.git
cd ArchiveBox cd ArchiveBox
@ -71,6 +67,8 @@ cd ArchiveBox
echo 'https://example.com' | ./archive echo 'https://example.com' | ./archive
``` ```
*(Recently [renamed](https://github.com/pirate/ArchiveBox/issues/108) from `Bookmark Archiver`)*
# Documentation # Documentation
We use the [Github wiki system](https://github.com/pirate/ArchiveBox/wiki) for documentation. We use the [Github wiki system](https://github.com/pirate/ArchiveBox/wiki) for documentation.