add changelog, update readme

Author: gambolputty

CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.1.0] - 2021-02-11
+### Added
+- Three new config variables (`MONGO_OUTSIDE_PORT`, `MAX_WORKERS`, `KEEP_DAYS`). See [readme](README.md) for details.
+- Network name for this project (`network name`)
+- Changelog file
+### Changed
+- Config variables are now uppercase
+- Readme
+
+## [1.0.0] - 2021-02-07
+### Added
+- Initial project release

README.md

@@ -22,7 +22,7 @@ Environment variables in `.env`:
 | MONGO_PASSWORD          | MongoDB password                                                                                                                   |
 | MONGO_DB_NAME           | MongoDB database name                                                                                                              |
 | MONGO_CREATE_TEXT_INDEX | `true` or `1` to let MongoDB create a text index (helpful for [text search](https://docs.mongodb.com/manual/text-search/))         |
-| MONGO_OUTSIDE_PORT      | Exposed MongoDB port on your host machine.                                                                                         |
+| MONGO_OUTSIDE_PORT      | Exposed MongoDB port, accessible on your host machine.                                                                                         |
 | MAX_WORKERS             | Number of worker threads for the crawler. Remove for auto assignment.                                                         |
 | KEEP_DAYS               | Discard articles older than **n** days. Default is "2".                                                                            |
 

crawler/app/crawler/__init__.py

@@ -25,6 +25,7 @@
 def init():
     ts = time()
     logger.info('Downloading new articles')
+    logger.info(f'Ignoring articles older than {config.KEEP_DAYS} days')
 
     if config.MAX_WORKERS:
         logger.info(f'Maximum crawler workers: {config.MAX_WORKERS}')