Skip to content

Commit 2b85ae3

Browse files
committed
fix docs
1 parent ff7aed2 commit 2b85ae3

File tree

2 files changed

+22
-37
lines changed

2 files changed

+22
-37
lines changed

CHANGES.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ Changelog
66
------------------
77

88
- Initial release.
9-
[mamico]
9+
[cekk]

README.rst

Lines changed: 21 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -31,34 +31,30 @@
3131
redturtle.rsync
3232
===============
3333

34-
An add-on for Plone
34+
This package provides sync features to massive upload contents in a Plone site.
3535

36-
Features
37-
--------
38-
39-
- Can be bullet points
36+
It generates a script in bin/redturtle_rsync that accept the following parameters:
4037

38+
- `--dry-run`: Dry-run mode (default is False)
39+
- `--verbose`: Verbose mode (default is False)
40+
- `--logpath LOGPATH`: Log destination path (relative to Plone site)
41+
- `--send-to-email SEND_TO_EMAIL`: Email address to send the log to
42+
- `--source-path SOURCE_PATH`: Local data source path (complementary to source-url)
43+
- `--source-url SOURCE_URL`: Remote data source URL (complementary to source-path)
4144

42-
Examples
43-
--------
44-
45-
This add-on can be seen in action at the following sites:
46-
- Is there a page on the internet where everybody can see the features?
45+
Example::
4746

47+
./bin/instance -OPlone run bin/redturtle_rsync --logpath /Plone/it/test-sync/log-sync --source-path /opt/some-data
4848

49-
Documentation
50-
-------------
5149

52-
Full documentation for end users can be found in the "docs" folder, and is also available online at http://docs.plone.org/foo/bar
53-
54-
55-
Translations
56-
------------
50+
Features
51+
--------
5752

58-
This product has been translated into
53+
This package provides a general tool to sync data and upload them in a Plone site.
5954

60-
- Klingon (thanks, K'Plai)
55+
You need to create an add-on to manage your specific data structure and content types that creates an adapter for IRedturtleRsyncAdapter.
6156

57+
It is also possible to add additional script options.
6258

6359
Installation
6460
------------
@@ -79,30 +75,19 @@ and then running ``bin/buildout``
7975
Authors
8076
-------
8177

82-
Provided by awesome people ;)
83-
84-
85-
Contributors
86-
------------
87-
88-
Put your name here, you deserve it!
78+
This product was developed by **RedTurtle Technology** team.
8979

90-
- ?
80+
.. image:: https://avatars1.githubusercontent.com/u/1087171?s=100&v=4
81+
:alt: RedTurtle Technology Site
82+
:target: http://www.redturtle.it/
9183

9284

9385
Contribute
9486
----------
9587

96-
- Issue Tracker: https://github.com/collective/redturtle.rsync/issues
97-
- Source Code: https://github.com/collective/redturtle.rsync
98-
- Documentation: https://docs.plone.org/foo/bar
99-
100-
101-
Support
102-
-------
88+
- Issue Tracker: https://github.com/RedTurtle/redturtle.rsync/issues
89+
- Source Code: https://github.com/RedTurtle/redturtle.rsync
10390

104-
If you are having issues, please let us know.
105-
We have a mailing list located at: project@example.com
10691

10792

10893
License

0 commit comments

Comments
 (0)