redo readme for new twine (#977)

martindurant · web-flow · commit d46c149d8959 · 2025-07-15T12:34:34.000-04:00
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -11,7 +11,7 @@ repos:
       - id: black
         exclude: ^docs/
   - repo: https://github.com/pycqa/flake8
-    rev: '4.0.1'
+    rev: '7.3.0'
     hooks:
       - id: flake8
         exclude: tests/|^docs/|__init__.py
diff --git a/README.md b/README.md
@@ -0,0 +1,18 @@
+s3fs
+====
+
+[|Build Status|](https://github.com/fsspec/s3fs/actions)
+[|Documentation|](https://s3fs.readthedocs.io/en/latest/?badge=latest)
+
+S3FS builds on [aiobotocore](https://aiobotocore.readthedocs.io/en/latest/)
+to provide a convenient Python filesystem interface for S3.
+
+
+Support
+-------
+
+Work on this repository is supported in part by:
+
+"Anaconda, Inc. - Advancing AI through open source."
+
+<a href="https://anaconda.com/"><img src="https://camo.githubusercontent.com/b8555ef2222598ed37ce38ac86955febbd25de7619931bb7dd3c58432181d3b6/68747470733a2f2f626565776172652e6f72672f636f6d6d756e6974792f6d656d626572732f616e61636f6e64612f616e61636f6e64612d6c617267652e706e67" alt="anaconda logo" width="40%"/></a>
diff --git a/README.rst b/README.rst
diff --git a/setup.py b/setup.py
@@ -39,5 +39,7 @@
         "awscli": [f"aiobotocore[awscli]{aiobotocore_version_suffix}"],
         "boto3": [f"aiobotocore[boto3]{aiobotocore_version_suffix}"],
     },
+    long_description="README.md",
+    long_description_content_type="text/markdown",
     zip_safe=False,
 )

Original file line number	Diff line number	Diff line change
`@@ -39,5 +39,7 @@`
`39`	`39`	`"awscli": [f"aiobotocore[awscli]{aiobotocore_version_suffix}"],`
`40`	`40`	`"boto3": [f"aiobotocore[boto3]{aiobotocore_version_suffix}"],`
`41`	`41`	`},`
	`42`	`+ long_description="README.md",`
	`43`	`+ long_description_content_type="text/markdown",`
`42`	`44`	`zip_safe=False,`
`43`	`45`	`)`