Update README

Structure and Contributing were both a bit out of date.
pull/977/head
Richard van der Hoff 8 years ago
parent b5d68b8ff1
commit 0e26238386

@ -4,8 +4,14 @@ Structure
========= =========
- ``api`` : Contains the HTTP API specification. - ``api`` : Contains the HTTP API specification.
- ``drafts`` : Contains documents which will make it into the specification - ``attic``: Contains historical sections of specification for reference
and/or supporting documentation at some point in the future. purposes.
- ``changelogs``: Contains change logs for the various parts of the
specification.
- ``drafts``: Previously, contained documents which were under discussion for
future incusion into the specification and/or supporting documentation. This
is now historical, as we use separate discussion documents (see
`<CONTRIBUTING.rst>`_).
- ``event-schemas``: Contains the `JSON Schema`_ for all Matrix events - ``event-schemas``: Contains the `JSON Schema`_ for all Matrix events
contained in the specification, along with example JSON files. contained in the specification, along with example JSON files.
- ``meta``: Contains documents outlining the processes involved when writing - ``meta``: Contains documents outlining the processes involved when writing
@ -22,9 +28,12 @@ Contributing
============ ============
Known issues with the specification are represented as JIRA issues at Known issues with the specification are represented as JIRA issues at
https://matrix.org/jira/browse/SPEC `<https://matrix.org/jira/browse/SPEC>`_.
If you want to ask more about the specification, or have suggestions for If you want to ask more about the specification, join us on
improvements, join us on ``#matrix-dev:matrix.org`` via https://matrix.org/beta. `#matrix-dev:matrix.org <http://matrix.to/#/#matrix-dev:matrix.org>`_.
If you would like to contribute to the specification or supporting
documentation, see `<CONTRIBUTING.rst>`_.
.. _JSON Schema: http://json-schema.org/ .. _JSON Schema: http://json-schema.org/

Loading…
Cancel
Save