Construí una API de back-end y quiero mostrarla en GitHub. ¿Qué información debe contener mi archivo Léame y qué estructura debe tener?

Me gusta este archivo Léame para el paquete JPMML:
jpmml / jpmml-evaluator

Tiene todo lo que necesitas:

  1. Características : qué hace esta API / paquete, qué tiene de bueno
  2. Prerrequisitos: ¿Qué necesito para usarlo?
  3. Instalación : si requiere instalación específica del sistema operativo, especifique para todos los sistemas operativos compatibles. Si utiliza la herramienta de compilación maven / gradle / other, especifique cómo se puede obtener el paquete a través de estas herramientas de compilación.
  4. Uso / ejemplos: Llamadas simples a la API, fragmentos de código simples con ejemplos sobre cómo trabajar con este paquete / API.
  5. Aplicaciones de ejemplo: ¿Dónde puedo obtener aplicaciones simples que usen esta API / paquete con las que pueda comenzar?
  6. Documentación : no especifique toda la documentación aquí, pero publique enlaces a las referencias de la API y otros documentos.
  7. Licencia : ¿qué licencia de código abierto utilizas? ¿Cómo puedo contactarlo en caso de que necesite una licencia comercial?
  8. Cómo contactarte

Cosas adicionales a considerar:

  • ¿Cómo puedo contribuir?
  • ID de versión estable actual
  • Uso recomendado
  • Probar tu código
  • Cómo construir
  • Enlace a la aplicación de seguimiento de problemas (JIRA, Pivotal-tracker, etc.) si usa alguna.

¡Espero que esto ayude!

More Interesting

¿Debería usar Django-CMS o WordPress para un blog si es desarrollador de Django y no tiene experiencia con PHP o WordPress?

¿Cómo se edita el código de otro sitio web y se ejecuta en mi propio sitio web?

Estoy empezando a aprender PHP, ¿me llevará un mes poder desarrollar una página web sencilla con él?

Estoy comenzando como desarrollador web en una compañía fantástica, sin embargo, no tienen sentido del diseño. ¿Cómo los convenzo de que es hora de cambiar?

Soy un desarrollador de JavaScript de pila completa. ¿Qué debería estar aprendiendo en mi trabajo actual para hacerme más atractivo para mi próximo trabajo?

¿Estoy solo en la sensación de que los CMS son más incómodos que útiles la mayor parte del tiempo?

Quiero crear un anti-ransomeware pero no tengo ningún desarrollador. ¿Como empiezo?

Conozco a algunos programadores que prefieren programar antes que realizar actividades realmente divertidas como ver películas y programas de televisión o incluso salir. No entiendo cómo es eso posible. ¿Cómo se puede explicar esto?

Quiero configurar un servidor de correo electrónico en mi servidor físico. ¿Cómo afectará mi tasa de entregabilidad?

¿Soy la única persona que piensa que jQuery y bootstrap deben colocarse en el compartimento 'no tocar este' del cinturón de herramientas del desarrollador / diseñador?

Estoy tratando de construir un backoffice para un sitio web, pero no quiero pasar por la molestia de diseñar los menús, formularios, etc. Estoy buscando una herramienta que me ayude a construir y aplicar un estilo estándar a mi páginas sin tener que escribir HTML y CSS. ¿Qué puedo usar?

Estoy empezando a desarrollar sitios web con WordPress. Estoy pensando en comprar el marco Genesis. ¿Qué debería estar considerando?

Conozco los conceptos básicos de JS, jQuery, PHP y HTML / CSS. Necesito crear un sitio web interactivo, para preguntas y respuestas para el público. ¿Cuáles son los siguientes pasos?

Ahora estoy aprendiendo desarrollo web. Estoy atrapado en CSS y JavaScript avanzados. Quiero rendirme. ¿Cómo supero este bloqueo mental y sigo adelante?

¿Qué debo saber para ser un desarrollador de sitios web o aplicaciones web? Tengo conocimiento de HTML y CSS. ¿Es necesario aprender JavaScript?