Update README.md #157
Update README.md #157
Conversation
adobeDan
left a comment
adobeDan
left a comment
There was a problem hiding this comment.
I think fixes are needed. See the comments.
README.md
Outdated
| @@ -1,3 +1,16 @@ | |||
| # Adobe User Sync Tool | |||
There was a problem hiding this comment.
It's a pretty sacrosanct Github tradition to tile the readme with the project name. Is there really a need to violate that here?
README.md
Outdated
| @@ -1,3 +1,16 @@ | |||
| # Adobe User Sync Tool | |||
|
|
|||
| The Adobe User Sync Tool is a command-line tool that moves user and group information from an organization's enterprise | |||
There was a problem hiding this comment.
"Adobe User Sync Tool" violates brand name guidelines and can't be used. You have to say "User Sync Tool from Adobe"
README.md
Outdated
| - [Step-by-Step Setup](https://adobe-apiplatform.github.io/user-sync.py/success-guide/) | ||
| - [Non-Technical Overview](https://spark.adobe.com/page/E3hSsLq3G1iVz/) | ||
|
|
||
| # user-sync.py |
There was a problem hiding this comment.
This header and the first paragraph now seem redundant. The material in the second paragraph (open source, etc., and the copyright) need to be further up in the file, as in immedately after the first paragraph.
I also think you can remove the Overview section, and go to Requirements right after Quick Links.
adobeDan
left a comment
adobeDan
left a comment
There was a problem hiding this comment.
Perfect, and nice solomonic solution to the header issue :).
No description provided.