Skip to content

Commit 14bf7ba

Browse files
committed
Update UserSecrets doc description.
1 parent 47f05a0 commit 14bf7ba

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,13 @@ This is the simplest of the config builders. It draws its values from Environmen
6363
[optional="true"]
6464
type="Microsoft.Configuration.ConfigurationBuilders.UserSecretsConfigBuilder, Microsoft.Configuration.ConfigurationBuilders.UserSecrets" />
6565
```
66-
To enable a feature similar to .Net Core's user secrets you can use this config builder. Microsoft is considering future plans to better integrate secret management
67-
into Visual Studio, and full-framework projects would use this config builder. In order to keep external dependencies out of the picture, the actual secret file will
68-
be xml formatted. (If you need to share a secrets.json file with Core projects, you could consider using the `SimpleJsonConfigBuilder` below.)
66+
To enable a feature similar to .Net Core's user secrets you can use this config builder. Microsoft is adding better secrets management in future releases
67+
of Visual Studio, and this config builder will be a part of that plan. Web Applications are the initial target for this work in Visual Studio, but this
68+
configuration builder can be used in any full-framework project if you specify your own secrets file. (Or define the 'UserSecretsId' property in your
69+
project file and create the raw secrets file in the correct location for reading.) In order to keep external dependencies out of the picture, the
70+
actual secret file will be xml formatted - though this should be considered an implementation detail, and the format should not be relied upon.
71+
(If you need to share a secrets.json file with Core projects, you could consider using the `SimpleJsonConfigBuilder` below... but as with this
72+
builder, the json format for Core secrets is technically an implementation detail subject to change as well.)
6973

7074
There are three additional configuration attributes for this config builder:
7175
* `userSecretsId` - This is the preferred method for identifying an xml secrets file. It works similar to .Net Core, which uses a 'UserSecretsId' project

0 commit comments

Comments
 (0)