/*
 * Copyright 2016 SimplifyOps, Inc. (http://simplifyops.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.dtolabs.rundeck.core.common;

/**
 * Descriptive metadata about a project
 */
public interface IProjectInfo {
    String getDescription();

    /**
     * @return readme text
     */
    String getReadme();

    /**
     * @return preprocessed readme HTML, or null to auto post-process
     */
    String getReadmeHTML();
    String getMotd();

    /**
     * @return preprocessed motd HTML, or null to auto post-process
     */
    String getMotdHTML();
}
