Skip to content

Commit

Permalink
Add CITATION.cff for automatic academic citation (#1351)
Browse files Browse the repository at this point in the history
* Add CITATION.cff for automatic academic citation

A `CITATION.cff` file has been added to the project to facilitate the generation of accurate academic citations directly from the GitHub page. This allows users to easily copy the citation and paste it into their academic papers. The file includes the project's information like title, authors, repository code, url, keywords, and license.

* Fixed category name
  • Loading branch information
JrooTJunior committed Oct 26, 2023
1 parent d8e7801 commit e3def60
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CHANGES/1351.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Added `CITATION.cff` file for automatic academic citation generation.
Now you can copy citation from the GitHub page and paste it into your paper.
23 changes: 23 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: aiogram
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Oleksandr
family-names: O
email: im@aiogram.dev
repository-code: 'https://github.com/aiogram/aiogram'
url: 'https://aiogram.dev'
abstract: >-
aiogram is a modern and fully asynchronous framework for
Telegram Bot API written in Python using asyncio
keywords:
- aiogram
- telegram
- bot
license: MIT

0 comments on commit e3def60

Please sign in to comment.