Update LICENSE so GitHub correctly detects license type

And some README formatting adjustments
requests-cache · Nov 23, 2020 · 9dc97f5 · 9dc97f5
1 parent eb8f3cc
commit 9dc97f5
Show file tree

Hide file tree

Showing 7 changed files with 39 additions and 23 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,9 +1,21 @@
-MIT License
-
-Copyright (c) 2020 Jordan Cook
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+MIT License
+
+Copyright (c) 2020 Jordan Cook
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,2 +1,2 @@
 include README.md HISTORY.md
-include LICENSE LICENSE_requests_cache
+include LICENSE requests_cache.md
diff --git a/README.md b/README.md
@@ -1,19 +1,19 @@
 # aiohttp-client-cache
-See full documentation at https://aiohttp-client-cache.readthedocs.io
 
 [![Build status](https://github.com/JWCook/aiohttp-client-cache/workflows/Build/badge.svg)](https://github.com/JWCook/aiohttp-client-cache/actions)
 [![Documentation Status](https://img.shields.io/readthedocs/aiohttp-client-cache/stable?label=docs)](https://aiohttp-client-cache.readthedocs.io/en/latest/)
 [![PyPI](https://img.shields.io/pypi/v/aiohttp-client-cache?color=blue)](https://pypi.org/project/aiohttp-client-cache)
 [![PyPI - Python Versions](https://img.shields.io/pypi/pyversions/aiohttp-client-cache)](https://pypi.org/project/aiohttp-client-cache)
 [![PyPI - Format](https://img.shields.io/pypi/format/aiohttp-client-cache?color=blue)](https://pypi.org/project/aiohttp-client-cache)
-
 <!--- [![Coverage Status](https://coveralls.io/repos/github/JWCook/aiohttp-client-cache/badge.svg?branch=master)](https://coveralls.io/github/JWCook/aiohttp-client-cache?branch=master) --->
 
-`aiohttp-client-cache` is an async persistent cache for [aiohttp](https://docs.aiohttp.org)
+See full documentation at https://aiohttp-client-cache.readthedocs.io
+
+**aiohttp-client-cache** is an async persistent cache for [aiohttp](https://docs.aiohttp.org)
 requests, based on [requests-cache](https://github.com/reclosedev/requests-cache).
 
 Not to be confused with [aiohttp-cache](https://github.com/cr0hn/aiohttp-cache), which is a cache
-for the aiohttp web server. This package is, as you might guess, specifically for the aiohttp client.
+for the aiohttp web server. This package is, as you might guess, specifically for the **aiohttp client**.
 
 ## Development Status
 **This is an early work in progress and not yet fully functional!**
@@ -31,7 +31,6 @@ pip install aiohttp-client-cache
 
 **Note:** You will need additional dependencies depending on which backend you want to use; See
 [Cache Backends](#cache-backends) section below for details.
-
 To install with extra dependencies for all supported backends:
 ```bash
 pip install aiohttp-client-cache[backends]
@@ -90,6 +89,7 @@ Thanks to [Roman Haritonov](https://github.com/reclosedev) and
 [contributors](https://github.com/reclosedev/requests-cache/blob/master/CONTRIBUTORS.rst)
 for the original `requests-cache`!
 
-This project is licensed under the MIT license, with the exception of portions reused from requests-cache
-(primarily its [storage backends](https://github.com/reclosedev/requests-cache/tree/master/requests_cache/backends/storage)),
-which is licensed under the BSD license (copy included).
+This project is licensed under the MIT license, with the exception of
+[storage backend code](https://github.com/reclosedev/requests-cache/tree/master/requests_cache/backends/storage)
+adapted from `requests-cache`, which is licensed under the BSD license
+([copy included](https://github.com/JWCook/aiohttp-client-cache/blob/master/requests_cache.md)).
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,8 +1,12 @@
-aiohttp-client-cache
-====================
+.. _index-page:
 
+.. Omit README link to ReadTheDocs, since we're already on ReadTheDocs!
 .. mdinclude:: ../README.md
-    :start-line: 2
+    :end-line: 9
+
+.. mdinclude:: ../README.md
+    :start-line: 11
+
 
 Contents
 ========

diff --git a/pyproject.toml b/pyproject.toml
@@ -10,7 +10,7 @@ directory = 'test-reports'
 
 [tool.coverage.run]
 branch = true
-source = ['pyinaturalist']
+source = ['aiohttp_client_cache']
 
 [tool.isort]
 profile = "black"

diff --git a/LICENSE_requests_cache → requests_cache.md b/LICENSE_requests_cache → requests_cache.md
diff --git a/setup.cfg b/setup.cfg
@@ -2,7 +2,7 @@
 author = Jordan Cook
 url = https://github.com/JWCook/aiohttp-client-cache
 description = Persistent cache for aiohttp requests
-keywords = aiohttp, async, asyncio, cache, client, http, persistence, requests
+keywords = aiohttp, async, asyncio, cache, cache-backends, client, http, persistence, requests, sqlite redis mongodb dynamodb
 license = MIT License
 long_description = file: README.md, HISTORY.md
 long_description_content_type = text/markdown