Implement core API and update rest of the repo

MANIFEST.in

@@ -1 +1 @@
-include maybe/py.typed
+include src/maybe/py.typed

README.rst

@@ -2,4 +2,54 @@
 Maybe
 ======
 
-Experimental. Do not use yet.
+======
+Result
+======
+
+.. image:: https://img.shields.io/github/actions/workflow/status/rustedpy/result/ci.yml?branch=master
+    :alt: GitHub Workflow Status (branch)
+    :target: https://github.com/rustedpy/result/actions/workflows/ci.yml?query=branch%3Amaster
+
+.. image:: https://codecov.io/gh/rustedpy/result/branch/master/graph/badge.svg
+    :alt: Coverage
+    :target: https://codecov.io/gh/rustedpy/result
+
+A simple Maybe (Option) type for Python 3 `inspired by Rust
+<https://doc.rust-lang.org/std/result/>`__, fully type annotated.
+
+Installation
+============
+
+Not yet available on PyPI. PyPI package coming soon.
+
+Latest GitHub ``master`` branch version:
+
+.. sourcecode:: sh
+
+   $ pip install git+https://github.com/rustedpy/result
+
+Summary
+=======
+
+**Experimental. API subject to change.**
+
+The idea is that a result value can be either ``Some(value)`` or ``Nothing()``,
+with a way to differentiate between the two. ``Some`` and ``Nothing`` are both classes
+encapsulating a possible value.
+
+Example usage,
+
+.. sourcecode:: Python
+
+    from rustedpy-maybe import Nothing, Some
+
+    o = Some('yay')
+    n = Nothing()
+    assert o.unwrap_or_else(str.upper) == 'yay'
+    assert n.unwrap_or_else(lambda: 'default') == 'default'
+
+
+License
+=======
+
+MIT License

RELEASING.md

@@ -21,7 +21,7 @@ vim CHANGELOG.md
 
 4) Do a signed commit and signed tag of the release:
 ```
-git add maybe/__init__.py CHANGELOG.md
+git add src/maybe/__init__.py CHANGELOG.md
 git commit -S${GPG} -m "Release v${VERSION}"
 git tag -u ${GPG} -m "Release v${VERSION}" v${VERSION}
 ```

setup.cfg

@@ -1,5 +1,5 @@
 [metadata]
-name = maybe
+name = rustedpy-maybe
 version = attr: maybe.__version__
 description = A Rust-like option type for Python
 long_description = file: README.rst

src/maybe/__init__.py

@@ -4,8 +4,6 @@
     SomeNothing,
     Maybe,
     UnwrapError,
-    as_async_maybe,
-    as_maybe,
     is_some,
     is_nothing,
 )
@@ -16,8 +14,6 @@
     "SomeNothing",
     "Maybe",
     "UnwrapError",
-    "as_async_maybe",
-    "as_maybe",
     "is_some",
     "is_nothing",
 ]