Merge pull request #8 from ft-circleci-orbs/update-cs-readme

Update cs readme

Author: robertboulton

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 <organization>
+Copyright (c) 2023 The Financial Times Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,39 +1,34 @@
-# Orb Template
+# Cloudsmith CircleCI Orb
 
-<!---
-[![CircleCI Build Status](https://circleci.com/gh/<organization>/<project-name>.svg?style=shield "CircleCI Build Status")](https://circleci.com/gh/<organization>/<project-name>) [![CircleCI Orb Version](https://badges.circleci.com/orbs/<namespace>/<orb-name>.svg)](https://circleci.com/developer/orbs/orb/<namespace>/<orb-name>) [![GitHub License](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/<organization>/<project-name>/master/LICENSE) [![CircleCI Community](https://img.shields.io/badge/community-CircleCI%20Discuss-343434.svg)](https://discuss.circleci.com/c/ecosystem/orbs)
+[![CircleCI](https://dl.circleci.com/status-badge/img/gh/ft-circleci-orbs/cloudsmith-circleci-orb/tree/main.svg?style=svg&circle-token=66e39b994c3e883286179e5683fdfe6d3c9926d8)](https://dl.circleci.com/status-badge/redirect/gh/ft-circleci-orbs/cloudsmith-circleci-orb/tree/main) [![GitHub License](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/ft-circleci-orbs/cloudsmith-circleci-orb/master/LICENSE)
 
---->
+A CircleCI orb to assist with downloading from and publishing packages to Cloudsmith.
 
-A project template for Orbs.
+---
+
+## Getting started
+
+The orb commands need the following parameters:
+
+* `repository_identifier` : The identity/slug of the Cloudsmith repository
 
-This repository is designed to be automatically ingested and modified by the CircleCI CLI's `orb init` command.
 
-_**Edit this area to include a custom title and description.**_
+* `service_identifier` : The identity/slug of the Cloudsmith service account to use when authenticating with OIDC
+
+This can be found in the [Cloudsmith UI](https://cloudsmith.io/orgs/financial-times/).
+
+The orb provides commands to set environment variables for various package managment tools (e.g. pip).
 
 ---
 
-## Resources
+## Documentation
 
-[CircleCI Orb Registry Page](https://circleci.com/developer/orbs/orb/<namespace>/<orb-name>) - The official registry page of this orb for all versions, executors, commands, and jobs described.
+Please see the [documention on the CircleCI orb registry](https://circleci.com/developer/orbs/orb/ft-circleci-orbs/cloudsmith-circleci).
 
-[CircleCI Orb Docs](https://circleci.com/docs/orb-intro/#section=configuration) - Docs for using, creating, and publishing CircleCI Orbs.
 
-### How to Contribute
+### Supported Package Management Tools
 
-We welcome [issues](https://github.com/<organization>/<project-name>/issues) to and [pull requests](https://github.com/<organization>/<project-name>/pulls) against this repository!
+**Python:** pip
+
+---
 
-### How to Publish An Update
-1. Merge pull requests with desired changes to the main branch.
-    - For the best experience, squash-and-merge and use [Conventional Commit Messages](https://conventionalcommits.org/).
-2. Find the current version of the orb.
-    - You can run `circleci orb info <namespace>/<orb-name> | grep "Latest"` to see the current version.
-3. Create a [new Release](https://github.com/<organization>/<project-name>/releases/new) on GitHub.
-    - Click "Choose a tag" and _create_ a new [semantically versioned](http://semver.org/) tag. (ex: v1.0.0)
-      - We will have an opportunity to change this before we publish if needed after the next step.
-4.  Click _"+ Auto-generate release notes"_.
-    - This will create a summary of all of the merged pull requests since the previous release.
-    - If you have used _[Conventional Commit Messages](https://conventionalcommits.org/)_ it will be easy to determine what types of changes were made, allowing you to ensure the correct version tag is being published.
-5. Now ensure the version tag selected is semantically accurate based on the changes included.
-6. Click _"Publish Release"_.
-    - This will push a new tag and trigger your publishing pipeline on CircleCI.