readme and Makefile

Author: willmcgugan

Makefile

@@ -0,0 +1,21 @@
+.PHONY: readme
+readme:
+	pandoc --from=markdown --to=rst --output=README.rst README.md
+
+.PHONY: release
+release: readme
+	python setup.py sdist bdist_wheel upload
+
+.PHONY: test
+test:
+	nosetests --with-coverage --cover-erase --cover-package=fs_s3fs fs_s3fs/tests
+	rm .coverage
+
+.PHONY: testall
+testall:
+	tox
+
+.PHONY: docs
+docs:
+	cd docs && make html
+	python -c "import os, webbrowser; webbrowser.open('file://' + os.path.abspath('./docs/build/html/index.html'))"

README.md

@@ -1,2 +1,7 @@
-# s3fs
-Work in Progress S3 filesystem 
+# S3FS
+
+S3FS is a [PyFilesystem interface](https://docs.pyfilesystem.org/) to
+Amazon S3 cloud storage.
+
+As a PyFilesystem concrete class, S3FS allows you to work with S3 in the
+same as any other supported filesystem.

README.rst

@@ -1 +1,8 @@
-Work in progress S3 Filesystem
+S3FS
+====
+
+S3FS is a `PyFilesystem interface <https://docs.pyfilesystem.org/>`__ to
+Amazon S3 cloud storage.
+
+As a PyFilesystem concrete class, S3FS allows you to work with S3 in the
+same as any other supported filesystem.

setup.py

@@ -6,7 +6,7 @@
     exec(f.read())
 
 CLASSIFIERS = [
-    'Development Status :: 5 - Production/Stable',
+    'Development Status :: 4 - Beta',
     'Intended Audience :: Developers',
     'License :: OSI Approved :: MIT License',
     'Operating System :: OS Independent',