summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/README.md b/README.md
index cfc23e6..777a8e1 100644
--- a/README.md
+++ b/README.md
@@ -154,7 +154,10 @@ options. See the ConfigState documentation for more details.
* DisablePointerMethods
Disables invocation of error and Stringer interface methods on types
- which only accept pointer receivers from non-pointer variables.
+ which only accept pointer receivers from non-pointer variables. This option
+ relies on access to the unsafe package, so it will not have any effect when
+ running in environments without access to the unsafe package such as Google
+ App Engine or with the "disableunsafe" build tag specified.
Pointer method invocation is enabled by default.
* ContinueOnMethod
@@ -177,6 +180,15 @@ options. See the ConfigState documentation for more details.
```
+## Unsafe Package Dependency
+
+This package relies on the unsafe package to perform some of the more advanced
+features, however it also supports a "limited" mode which allows it to work in
+environments where the unsafe package is not available. By default, it will
+operate in this mode on Google App Engine. The "disableunsafe" build tag may
+also be specified to force the package to build without using the unsafe
+package.
+
## License
Go-spew is licensed under the liberal ISC License.