Skip to content

Commit

Permalink
Update installation docs in preparation for this becoming a pypi-inst…
Browse files Browse the repository at this point in the history
…allable package
  • Loading branch information
gasman committed Jan 9, 2020
1 parent 25047e9 commit 89a7dac
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 8 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ RFC: https://github.com/wagtail/rfcs/pull/42

## Installation

* Check out this repository and run `pip install -e .` from the root
* Install the package with `pip install wagtail-transfer`
* Add `'wagtail_transfer'` to your project's `INSTALLED_APPS`
* In your project's top-level urls.py, add:

Expand Down
10 changes: 4 additions & 6 deletions docs/setup.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
#Setup

1. Clone the [Wagtail Transfer repository](https://github.com/wagtail/wagtail-transfer).
1. Install the wagtail-transfer package with `pip install wagtail-transfer`.

2. In the terminal, navigate to the root of the cloned repository and run `pip install -e` .
2. Add `wagtail_transfer` to your project's `INSTALLED_APPS`.

3. Add `wagtail_transfer` to your project's `INSTALLED_APPS`.

4. In your project's top-level urls.py, add:
3. In your project's top-level urls.py, add:

from wagtail_transfer import urls as wagtailtransfer_urls

Expand All @@ -16,7 +14,7 @@

to the `urlpatterns` list above `include(wagtail_urls)`.

5. Add the settings `WAGTAILTRANSFER_SOURCES` and `WAGTAILTRANSFER_SECRET_KEY` to your project settings.
4. Add the settings `WAGTAILTRANSFER_SOURCES` and `WAGTAILTRANSFER_SECRET_KEY` to your project settings.
These are formatted as:

WAGTAILTRANSFER_SOURCES = {
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
license='BSD',
long_description="An extension for Wagtail allowing content to be transferred between multiple instances of a Wagtail project",
classifiers=[
'Development Status :: 3 - Alpha',
'Development Status :: 4 - Beta',
'Environment :: Web Environment',
'Intended Audience :: Developers',
'License :: OSI Approved :: BSD License',
Expand Down

0 comments on commit 89a7dac

Please sign in to comment.