diff --git a/src/Environment.js b/src/Environment.js new file mode 100644 index 0000000..15b91d2 --- /dev/null +++ b/src/Environment.js @@ -0,0 +1,17 @@ +export default { + + /** + * A generic container for RecogitoJS/Annotorious + * to store globally available environment info. The + * most important piece of information is user auth + * info. Example: + * + * user: { id, displayName, email, avatarURL } + * + * id ........... the host application user ID (should be a URI, but could be username) REQUIRED + * displayName .. screen display or nickname OPTIONAL (id is used when empty) + * email ........ OPTIONAL + * avatarURL .... OPTIONAL + not supported at the moment + */ + +} \ No newline at end of file diff --git a/src/index.js b/src/index.js index 201c24f..3dc1c21 100644 --- a/src/index.js +++ b/src/index.js @@ -1,3 +1,4 @@ +export { default as Environment } from './Environment'; export { default as TextAnnotator } from './TextAnnotator'; export { default as WebAnnotation } from './WebAnnotation';