From 59c1c8e83a4d9d90efddb88eed2d0869993f7882 Mon Sep 17 00:00:00 2001 From: Andrew-Chen-Wang Date: Tue, 22 Nov 2022 13:39:59 -0500 Subject: [PATCH] Update docs Signed-off-by: Andrew-Chen-Wang --- README.md | 4 ++++ docs/project-generation-options.rst | 7 +++++++ 2 files changed, 11 insertions(+) diff --git a/README.md b/README.md index 9f2af6d37..650730849 100644 --- a/README.md +++ b/README.md @@ -108,6 +108,10 @@ Answer the prompts with your own desired [options](http://cookiecutter-django.re author_name [Daniel Roy Greenfeld]: Daniel Greenfeld domain_name [example.com]: myreddit.com email [daniel-greenfeld@example.com]: pydanny@gmail.com + Select username_type: + 1 - username + 2 - email + Choose from 1, 2 [1]: 1 version [0.1.0]: 0.0.1 Select open_source_license: 1 - MIT diff --git a/docs/project-generation-options.rst b/docs/project-generation-options.rst index 2d8103cf2..5499c79c6 100644 --- a/docs/project-generation-options.rst +++ b/docs/project-generation-options.rst @@ -24,6 +24,13 @@ author_name: email: The email address you want to identify yourself in the project. +username_type: + The type of username you want to use in the project. This can be either + ``username`` or ``email``. If you choose ``username``, the ``email`` field + will be included. If you choose ``email``, the ``username`` field will be + excluded. It is best practice to always include an email field, so there is + no option for having just the ``username`` field. + domain_name: The domain name you plan to use for your project once it goes live. Note that it can be safely changed later on whenever you need to.