Improved Publishing a Package section

Author: vinzbarbuto

blog/2024-11-11-package.md

@@ -5,11 +5,11 @@ authors: [vinzbarbuto]
 tags: [packages, packaging, lingua franca, docs]
 ---
 
-The Lingua Franca (LF) [Package Explorer](/docs/tools/code-extension#package-explorer) is a new feature within the Lingua Franca Visual Studio Code extension, built to streamline package management for developers. Supporting both local and remote sources, the Package Explorer enables effortless listing and management of packages—whether defined locally by developers or installed through the Lingo Package Manager. This integration aligns with the Lingua Franca community’s vision for a collaborative and reusable ecosystem. Developers can create and publish their own packages, enabling others to easily incorporate these resources into their projects. This collaborative model not only enhances programmability and accelerates product development but also simplifies the design of complex Lingua Franca applications.
+The Lingua Franca (LF) [Package Explorer](/docs/tools/code-extension#package-explorer) is a new feature within the Lingua Franca Visual Studio Code extension, built to streamline package management for developers. Supporting both local and remote sources, the Package Explorer enables effortless listing and management of packages—whether defined locally by developers or installed through the Lingo Package Manager. This integration aligns with the Lingua Franca community's vision for a collaborative and reusable ecosystem. Developers can create and publish their own packages, enabling others to easily incorporate these resources into their projects. This collaborative model not only enhances programmability and accelerates product development but also simplifies the design of complex Lingua Franca applications.
 
 {/* truncate */}
 
-In this guide, we’ll walk you through the essential steps to create and publish a package to the community repository, covering:
+In this guide, we'll walk you through the essential steps to create and publish a package to the community repository, covering:
 
 1. [**Creating a New Package**](#creating-a-package)  
    Get started by setting up your package with the required files and directory structure to meet Lingua Franca standards.
@@ -25,7 +25,7 @@ By the end of this guide, you'll have a fully configured, shareable package read
 ## Creating a New Package
 You can create a new [LF package](/docs/glossary/#package) either manually by creating an [LF file](/docs/glossary/#lf-file) or by using the [Lingo Package Manager](https://github.com/lf-lang/lingo).
 
-#### Option 1: Create a Project Using the Lingo Package Manager (Recommended)
+#### Option 1: Create a project using the Lingo Package Manager (recommended)
 1. After [installing the Lingo Package Manager](https://www.lf-lang.org/docs/installation#lingo), create an empty directory to serve as the root of your new package.
 2. Open the terminal in this folder and run the <kbd>lingo init</kbd> command. 
 
@@ -38,7 +38,7 @@ This will set up a new LF package with the following structure:
 └── └── Lingo.toml # Configuration file for current package
 ```
 
-#### Option 2: Manually Create the Required Files
+#### Option 2: Manually create the required files
 1. Go to <kbd>File > New File...</kbd> and select `New Lingua Franca File`.
 2. Save the file in a directory called `src` to ensure that generated code is placed in a parallel `src-gen` directory. For example, if your file is called `Foo.lf`, the directory structure after building will look like this:
 
@@ -55,7 +55,7 @@ This will set up a new LF package with the following structure:
 
 If you manually create the `Lingo.toml` file, place it adjacent to the `src` folder in the root directory of the package. This file serves as a configuration for the package, allowing you to specify the package name, version, and other metadata, including any dependencies you want to install.
 
-### Add `src/lib/` for Local Libraries
+### Add `src/lib/` for local libraries
 
 To include local libraries in your Lingua Franca project, create a `lib` directory within the `src/` folder and place your LF files there. These files contain reusable reactors that can be used within the same package or, if published, in other packages via the Lingo Package Manager. The `src/lib` directory is the default location for Lingua Franca files your project exports, enabling other libraries to use them. This setup simplifies managing and reusing libraries across Lingua Franca projects. 
 
@@ -75,7 +75,7 @@ The `lib` directory should be placed alongside the `src` directory, organized as
 
 In LF, there is no visibility control, meaning you cannot mark a reactor or file as `private` as in other programming languages. The `private` directory serves this purpose by containing files meant solely for internal package use. Files in this directory are hidden in the Package Explorer within the VS Code extension, making them inaccessible to other packages. The `private` directory is useful for implementing design patterns like the Abstract Factory Pattern, which provides an interface for creating families of related objects without specifying concrete classes. For example, a developer might define an `AbstractLibraryFile.lf` containing abstract reactors and implement them in various ways within different files under the `lib` directory.
 
-### Must-Follow Guidelines
+### Must-follow guidelines
 
 When creating a new package, ensure that you follow these guidelines:
 
@@ -122,16 +122,30 @@ Publishing your package makes it accessible to other developers, enabling them t
 
 Follow these steps to publish your package:  
 
-#### 1. Push Your Package to Your GitHub Repository  
+#### 1. Push your package to your GitHub repository  
 Upload your package to your own (public) GitHub repository. This allows you to share it immediately.  
 
-#### 2. Follow the `<name>-<target>` Naming Scheme  
+#### 2. Follow the `<name>-<target>` naming scheme
 Name your repository using the format `<name>-<target>`. For example, `package-python`.  
 - Use lowercase letters and hyphens.  
 - Ensure `<name>` is descriptive and unique.  
 - Specify `<target>` as the package's target language.  
 
-#### 3. Add the Maintainer's Name to the Repository Description  
-This helps others know who to contact for questions or assistance.  
+#### 3. Add the maintainer's name to the repository description
+This helps others know who to contact for questions or assistance.
+
+#### 4. List the package in the Lingua Franca Package Registry
+
+After publishing your package, you can make it discoverable by listing it in the [Lingua Franca Package Registry](https://github.com/lf-lang/pkgs). To add your package:
+
+1. Fork the [pkgs](https://github.com/lf-lang/pkgs) repository
+2. Find the appropriate target language section in `README.md` (e.g., C, Cpp, Python)
+3. Add your package entry in alphabetical order using this format:
+
+   ```
+   - [package-name](link-to-repository)
+   ```
+   
+4. Submit a pull request to the `pkgs` repository for review
 
 By following these steps, you ensure your package is properly organized and ready for community use.