diff --git a/README.md b/README.md index 1ae8d7b4..ea44d79e 100644 --- a/README.md +++ b/README.md @@ -1,103 +1,17 @@ -# Daytona +# AI Transcription Tool -
- - - Daytona logo - -
+## Supported APIs +- OpenAI +- Groq -
+## Installation +1. Clone the repository +2. Install dependencies +3. Configure API keys -[![Issues - Content](https://img.shields.io/github/issues/daytonaio/content)](https://github.com/daytonaio/content/issues) -[![Vaunt Community](https://api.vaunt.dev/v1/github/entities/daytonaio/repositories/content/badges/community)](https://community.vaunt.dev/board/daytonaio/repository/content) +## Usage +1. Import the API module +2. Call the transcription function -
- -# Daytona Content Programme for Technical Writers - -Welcome to the [Daytona](https://www.daytona.io) `content` repository! This repo -is dedicated to managing external technical writers who contribute articles and -guides. Here, you'll find details on how to participate, contribute, and get -compensated for your work. - -## Table of Contents - -- [Daytona Content Programme for Technical Writers](#daytona-content-programme-for-technical-writers) - - [Table of Contents](#table-of-contents) - - [Introduction](#introduction) - - [Where to Start](#where-to-start) - - [Licensing and Copyright](#licensing-and-copyright) - - [Payment](#payment) - - [Contact and Support](#contact-and-support) - - [Showcase Your Contributions](#showcase-your-contributions) - - [Top Contributors](#top-contributors) - -# Introduction - -The `content` repository is a platform where technical writers can contribute -articles to the [Daytona Dotfiles Insider](https://www.daytona.io/dotfiles/) -blog by "solving" posted issues (proposed article ideas) through pull requests. -Merged PRs are eligible for compensation. - -> **Note:** Always use GitHub as the main communication channel. For questions -> not directly related to the project or for general clarifications, join the -> designated `content` channel on the Daytona Community Slack. - -## Where to Start - -Please refer to our [CONTRIBUTING.md](CONTRIBUTING.md) file for detailed -information on how to contribute to this project. - -## Licensing and Copyright - -By contributing to this repository, you agree that all content you submit is -subject to the terms outlined in the [CONTRIBUTING.md](CONTRIBUTING.md) file. - -## Payment - -- Compensation is provided for accepted and published content. -- Payment can be made through Algora as bounties (if assigned to the issue and - your PR gets merged). - -## Contact and Support - -- For questions or assistance, open an issue or contact the repo maintainers. -- Join `#content` channel in our [Slack community](https://go.daytona.io/slack) - for discussions and support. - -## Showcase Your Contributions - -Along with the chance to earn bounties, each engagement comes with an -achievement badge. - -Showcase your contributions in your GitHub profile and display your achievements -with pride! For more information, check the -[CONTRIBUTING.md](CONTRIBUTING.md#showcase-your-contributions) file. - -### Top Contributors - -

- -

- -You can showcase your achievement badges on your GitHub profile in the following -way: - -

- -

- -Simply add the following code to your GitHub profile README file: - -```html -

- -

-``` - -Happy writing, and thank you for contributing to the Daytona Dotfiles Insider -blog! +## Guide +For detailed instructions on how to use the API support, please refer to the [long-form guide](articles/20241212_long_form_guide.md). diff --git a/articles/20241212_long_form_guide.md b/articles/20241212_long_form_guide.md new file mode 100644 index 00000000..56d2167e --- /dev/null +++ b/articles/20241212_long_form_guide.md @@ -0,0 +1,16 @@ +# Long-Form Guide to Using the AI Transcription Tool + +## Introduction +This guide will walk you through the process of using the AI Transcription Tool with OpenAI and Groq APIs. + +## Step 1: Installation +1. Clone the repository +2. Install dependencies +3. Configure API keys + +## Step 2: Usage +1. Import the API module +2. Call the transcription function + +## Conclusion +By following this guide, you should now be able to use the AI Transcription Tool with OpenAI and Groq APIs.