Skip to content

Commit

Permalink
#25169 Apps Framework README > Split out admin content to child pages (
Browse files Browse the repository at this point in the history
…#481)

* Updated Readme and created admin-guide

* Removed admin and contacts section and renaming done

* Changed the position of develop an app

* Changed the position of deploy and install section
  • Loading branch information
Reene-Simon authored Nov 9, 2023
1 parent c0be1b2 commit ef75cdd
Showing 1 changed file with 14 additions and 9 deletions.
23 changes: 14 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,30 @@
# mattermost-plugin-apps
# Mattermost Apps Framework Plugin

![CircleCI branch](https://img.shields.io/circleci/project/github/mattermost/mattermost-plugin-apps/master.svg)
[![Code Coverage](https://img.shields.io/codecov/c/github/mattermost/mattermost-plugin-apps/master.svg)](https://codecov.io/gh/mattermost/mattermost-plugin-apps/branch/master)
[![Go Report Card](https://goreportcard.com/badge/github.com/mattermost/mattermost-plugin-apps)](https://goreportcard.com/report/github.com/mattermost/mattermost-plugin-apps)

# Mattermost Apps
## Contents
- [Overview](#overview)
- [Deploying and Installing Apps](#deploying-and-installing-apps)
- [Develop an App](#develop-an-app)
- [Running the Tests](#running-the-tests)

## Overview

This plugin serves as the core of the Mattermost Apps Framework. It extends the Mattermost server's API to allow for the creation of feature-rich integrations, with functionality supported on the Mattermost web client and mobile client. Take a look at the [app developer documentation](https://developers.mattermost.com/integrate/apps) for more information.

Join the [Mattermost Apps channel](https://community.mattermost.com/core/channels/mattermost-apps) on our community server to discuss technical details and use cases for the app you're creating.

## Getting Started
## Deploying and Installing Apps

See [documentation](https://developers.mattermost.com/integrate/apps/deploy/)

## Develop an App

Refer to the [Mattermost Apps Quick Start Guide](https://developers.mattermost.com/integrate/apps/quickstart/) for instructions on how to use the development environment and examples in the [mattermost/mattermost-app-examples](https://github.com/mattermost/mattermost-app-examples) repository.

## Running the tests
## Running the Tests

`mattermost-plugin-apps` has two types of tests: unit tests and end to end tests.

Expand Down Expand Up @@ -44,11 +54,6 @@ Change your directory back to `mattermost-plugin-apps` and run the end to end te
make test-e2e
```

## Deploying and Installing Apps

See [documentation](https://developers.mattermost.com/integrate/apps/deploy/)

## Contacts

- Dev: Lev Brouk (@lev.brouk)
- PM: Aaron Rothschild (@aaron.rothschild)

0 comments on commit ef75cdd

Please sign in to comment.