diff --git a/README.md b/README.md index a3a56594a..44911403c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Alfresco Example Content Application

- Alfresco + Alfresco - make business flow

## Introduction @@ -9,29 +9,50 @@ The Alfresco Content Application is an example application built using [Alfresco Application Development Framework (ADF)](https://github.com/Alfresco/alfresco-ng2-components) components and was generated with [Angular CLI](https://github.com/angular/angular-cli). +The Alfresco Content Application is an example application built using [Alfresco Application Development Framework (ADF)](https://github.com/Alfresco/alfresco-ng2-components) components and was generated with [Angular CLI](https://github.com/angular/angular-cli). + ### Who is this example application for -This example application demonstrates to Angular software engineers -how to construct a content application using the Alfresco ADF. +This example application demonstrates how to construct an application for Alfresco Content Services using the Alfresco ADF and represents a meaningful composition of ADF components that provide end users with a simple easy to use interface for working with files in the content repository. -This example application represents a meaningful composition of ADF components that provide end users -with a simple and easy to use interface for working with files stored in the Alfresco Content Services repository. +### Where to get help +There are a number of resources available to help get you started with the Content App and the ADF: +* [Content App Documentation](https://alfresco.github.io/alfresco-content-app/) +* [Alfresco ADF Documentation](https://alfresco.github.io/adf-component-catalog/) +* [Alfresco Community](https://community.alfresco.com/) +* [ADF Gitter Channel](https://gitter.im/Alfresco/alfresco-ng2-components) -[Public documentation](https://alfresco.github.io/alfresco-content-app/) +To get help on Angular CLI use ng help or read the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md). ### Raising issues and feature requests +Isuses can be raised in GitHub or in the Alfresco JIRA project. +Please include a clear description, steps to reproduce and screenshots where appropriate.All issues will be reviewed; bugs will be categorized if reproducible and enhancement/feature suggestions will be considered against existing priorities if the use case serves a general-purpose need. -Log any issues in the ['ACA' JIRA project](https://issues.alfresco.com/jira/projects/ACA), -please include a clear description, steps to reproduce and screenshots where appropriate. +#### High level features planned for Q3 2018 (July - September) +* Library Management - create, find, join and manage file libraries. +* Commenting - View and add comments to files and folders +* Sharing Files - activate and deactivate shared file both manually and automatically. +* Permissions - update file and folder permissions. +* Application Extensibility - Extension framework to provide simple ways to extend the application. -All issues will be reviewed; bugs will be categorized if reproducible and enhancement/feature suggestions -will be considered against existing priorities if the use case serves a general-purpose need. +### Want to help? +Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our guidelines for [contributing](https://github.com/Alfresco/alfresco-content-app/blob/master/CONTRIBUTING.md) and then check out one of our issues in the [Jira](https://issues.alfresco.com/jira/projects/ACA) or [GitHub](https://github.com/Alfresco/alfresco-content-app/issues) -## Want to help? +## Available Features +| Feature | Description | +|------------------|----------------------------------------------------------------| +| Document List | Folder/File browsing of Personal Files, and File Libraries | +| Shared Files | Lists all files that have shared. | +| Recent Files | List files created and/or modified by the logged users within the last 30 days| +| Favorites | Lists all favorited files for the user. | +| Trash | Lists all deleted items stored in the trash can, users can restore or permanently remove. Admin user will see items deleted by all users.| +| Upload | Files and folders can be uploaded through the New button or by dragging and dropping into the browser.| +| Search | Quick search with live results, and full faceted search results page.| +| Actions | A number of actions can be performed on files and/or folders, either individually or multiples at a time| +| Viewer | Viewing files in natively in the browser, unsupported formats are transformed by the repository | +| Metadata | The information drawer can be configured in the app.config.json to display metadata information, by default file the Properties Aspect is shown and images will also include EXIF information.| +| Versioning | The version manager provides access and management of previous file versions, and the ability to upload new versions.| -Want to file a bug, contribute some code, or improve documentation? Excellent! -Read up on our guidelines for [contributing][contributing] -and then check out one of our issues in the [Jira][jira] or [GitHub][github] ## Development server