Improve readme

Gábor Hojtsy - March 8, 2009 - 06:19
Project:OpenID Provider
Version:6.x-1.x-dev
Component:Documentation
Category:task
Priority:normal
Assigned:Unassigned
Status:reviewed & tested by the community
Description

One thing which makes this module hard to test and understand is that the README.txt is way too basic. Here is a start of doing it better, so that people understand what does this module do, and a little bit more on how. For example, the existing text might suggest that it requires the OpenID module turned on, but it does not. It was totally confusing for me as I read it.

AttachmentSize
litte-better-readme.patch1.09 KB

#1

anarcat - March 9, 2009 - 15:55
Status:needs review» needs work

The URL is likely to change based on #322764: Adding patch to support new OpenID Provider Path, to user/%/identity. Otherwise ready to commit.

#2

alex_b - March 9, 2009 - 19:36

Updated to reflect changes by #322764: Adding patch to support new OpenID Provider Path.

RTBC after 322764 lands.

AttachmentSize
litte-better-readme.patch 1.16 KB

#3

alex_b - March 9, 2009 - 19:37
Status:needs work» needs review

Something weird is going on with these comments when I attach patches. Setting status.

#4

anarcat - March 13, 2009 - 00:48
Status:needs review» reviewed & tested by the community

Looks fine to me.

 
 

Drupal is a registered trademark of Dries Buytaert.